Skip to content

User Config F Fmpeg Dto

immichpy.client.generated.models.user_config_f_fmpeg_dto.UserConfigFFmpegDto pydantic-model

Bases: BaseModel

UserConfigFFmpegDto

Show JSON schema: 
{
  "$defs": {
    "HlsVideoResolution": {
      "description": "HLS video resolution",
      "enum": [
        480,
        720,
        1080,
        1440,
        2160
      ],
      "title": "HlsVideoResolution",
      "type": "integer"
    },
    "UserConfigFFmpegRealtimeDto": {
      "description": "UserConfigFFmpegRealtimeDto",
      "properties": {
        "enabled": {
          "description": "Enable real-time HLS transcoding (alpha)",
          "title": "Enabled",
          "type": "boolean"
        },
        "resolutions": {
          "description": "Resolutions to use for real-time HLS transcoding",
          "items": {
            "$ref": "#/$defs/HlsVideoResolution"
          },
          "title": "Resolutions",
          "type": "array"
        },
        "videoCodecs": {
          "description": "Video codecs to use for real-time HLS transcoding",
          "items": {
            "$ref": "#/$defs/VideoCodec"
          },
          "title": "Videocodecs",
          "type": "array"
        }
      },
      "required": [
        "enabled",
        "resolutions",
        "videoCodecs"
      ],
      "title": "UserConfigFFmpegRealtimeDto",
      "type": "object"
    },
    "VideoCodec": {
      "description": "Target video codec",
      "enum": [
        "h264",
        "hevc",
        "vp9",
        "av1"
      ],
      "title": "VideoCodec",
      "type": "string"
    }
  },
  "description": "UserConfigFFmpegDto",
  "properties": {
    "realtime": {
      "$ref": "#/$defs/UserConfigFFmpegRealtimeDto"
    }
  },
  "required": [
    "realtime"
  ],
  "title": "UserConfigFFmpegDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of UserConfigFFmpegDto from a dict

Source code in immichpy/client/generated/models/user_config_f_fmpeg_dto.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserConfigFFmpegDto from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "realtime": UserConfigFFmpegRealtimeDto.from_dict(obj["realtime"])
            if obj.get("realtime") is not None
            else None
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of UserConfigFFmpegDto from a JSON string

Source code in immichpy/client/generated/models/user_config_f_fmpeg_dto.py 
52
53
54
55
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserConfigFFmpegDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in immichpy/client/generated/models/user_config_f_fmpeg_dto.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def to_dict(self) -> Dict[str, Any]:
    """Return the dictionary representation of the model using alias.

    This has the following differences from calling pydantic's
    `self.model_dump(by_alias=True)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: Set[str] = set([])

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    # override the default output from pydantic by calling `to_dict()` of realtime
    if self.realtime:
        _dict["realtime"] = self.realtime.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/user_config_f_fmpeg_dto.py 
48
49
50
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/user_config_f_fmpeg_dto.py 
44
45
46
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))