Share via

LiveEventEncoding Class

  • Reference

Specifies the live event type and optional encoding settings for encoding live events.

Inheritance
azure.mgmt.media._serialization.Model
LiveEventEncoding

Constructor

LiveEventEncoding(*, encoding_type: str | _models.LiveEventEncodingType | None = None, preset_name: str | None = None, stretch_mode: str | _models.StretchMode | None = None, key_frame_interval: timedelta | None = None, **kwargs)

Keyword-Only Parameters

Name Description
encoding_type
str or LiveEventEncodingType

Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. Known values are: "None", "Standard", "Premium1080p", "PassthroughBasic", and "PassthroughStandard".
preset_name
str

The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is 'Default720p'. Else if the encodingType is set to Premium1080p, the default preset is 'Default1080p'.
stretch_mode
str or StretchMode

Specifies how the input video will be resized to fit the desired output resolution(s). Default is None. Known values are: "None", "AutoSize", and "AutoFit".
key_frame_interval
timedelta

Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events.

Variables

Name Description
encoding_type
str or LiveEventEncodingType

Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. Known values are: "None", "Standard", "Premium1080p", "PassthroughBasic", and "PassthroughStandard".
preset_name
str

The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is 'Default720p'. Else if the encodingType is set to Premium1080p, the default preset is 'Default1080p'.
stretch_mode
str or StretchMode

Specifies how the input video will be resized to fit the desired output resolution(s). Default is None. Known values are: "None", "AutoSize", and "AutoFit".
key_frame_interval
timedelta

Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events.