LiveEventEncoding Class

  • java.lang.Object
    • com.azure.resourcemanager.mediaservices.models.LiveEventEncoding

public final class LiveEventEncoding

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

Constructor Summary

Constructor Description
LiveEventEncoding()

Creates an instance of LiveEventEncoding class.

Method Summary

Modifier and Type Method and Description
LiveEventEncodingType encodingType()

Get the encodingType property: Live event type.

Duration keyFrameInterval()

Get the keyFrameInterval property: 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.

String presetName()

Get the presetName property: The optional encoding preset name, used when encodingType is not None.

StretchMode stretchMode()

Get the stretchMode property: Specifies how the input video will be resized to fit the desired output resolution(s).

void validate()

Validates the instance.

LiveEventEncoding withEncodingType(LiveEventEncodingType encodingType)

Set the encodingType property: Live event type.

LiveEventEncoding withKeyFrameInterval(Duration keyFrameInterval)

Set the keyFrameInterval property: 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.

LiveEventEncoding withPresetName(String presetName)

Set the presetName property: The optional encoding preset name, used when encodingType is not None.

LiveEventEncoding withStretchMode(StretchMode stretchMode)

Set the stretchMode property: Specifies how the input video will be resized to fit the desired output resolution(s).

Methods inherited from java.lang.Object

Constructor Details

LiveEventEncoding

public LiveEventEncoding()

Creates an instance of LiveEventEncoding class.

Method Details

encodingType

public LiveEventEncodingType encodingType()

Get the encodingType property: 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.

Returns:

the encodingType value.

keyFrameInterval

public Duration keyFrameInterval()

Get the keyFrameInterval property: 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.

Returns:

the keyFrameInterval value.

presetName

public String presetName()

Get the presetName property: 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 \u2018Default720p\u2019. Else if the encodingType is set to Premium1080p, the default preset is \u2018Default1080p\u2019.

Returns:

the presetName value.

stretchMode

public StretchMode stretchMode()

Get the stretchMode property: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None.

Returns:

the stretchMode value.

validate

public void validate()

Validates the instance.

withEncodingType

public LiveEventEncoding withEncodingType(LiveEventEncodingType encodingType)

Set the encodingType property: 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.

Parameters:

encodingType - the encodingType value to set.

Returns:

the LiveEventEncoding object itself.

withKeyFrameInterval

public LiveEventEncoding withKeyFrameInterval(Duration keyFrameInterval)

Set the keyFrameInterval property: 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.

Parameters:

keyFrameInterval - the keyFrameInterval value to set.

Returns:

the LiveEventEncoding object itself.

withPresetName

public LiveEventEncoding withPresetName(String presetName)

Set the presetName property: 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 \u2018Default720p\u2019. Else if the encodingType is set to Premium1080p, the default preset is \u2018Default1080p\u2019.

Parameters:

presetName - the presetName value to set.

Returns:

the LiveEventEncoding object itself.

withStretchMode

public LiveEventEncoding withStretchMode(StretchMode stretchMode)

Set the stretchMode property: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None.

Parameters:

stretchMode - the stretchMode value to set.

Returns:

the LiveEventEncoding object itself.

Applies to