LiveTranscoding class

Transcoding properties for CDN live streaming.

Annotations

• @JsonSerializable.new(explicitToJson: true, includeIfNull: false)

Properties

advancedFeatureCount → int?

Number of enabled advanced features. Default is 0.

final

advancedFeatures → List<LiveStreamAdvancedFeature>?

Advanced features for transcoding and streaming. See LiveStreamAdvancedFeature.

final

audioBitrate → int?

Bitrate of the output audio for CDN live streaming, in Kbps. Default is 48, maximum is 128.

final

audioChannels → int?

Number of audio channels in the output audio for CDN live streaming. Default is 1. Acceptable integer values are 1,5. Recommended values are 1 or 2. Values 3, 4, and 5 require special player support: 1: (Default) Mono 2: Stereo 3: Three channels 4: Four channels 5: Five channels

final

audioCodecProfile → AudioCodecProfileType?

Audio codec profile of the output audio for CDN live streaming. See AudioCodecProfileType.

final

audioSampleRate → AudioSampleRateType?

Audio sample rate (Hz) of the output media stream for CDN streaming. See AudioSampleRateType.

final

backgroundColor → int?

Background color of the output video for CDN live streaming, in hexadecimal RGB integer format without the # sign. For example, 0xFFB6C1 represents light pink. Default is 0x000000 (black).

final

backgroundImage → List<RtcImage>?

Background image on the live video. The image format must be PNG. See RtcImage. You can add one background image or use an array to add multiple background images. This parameter is used together with backgroundImageCount.

final

backgroundImageCount → int?

Number of background images on the live video. The total number of watermarks and background images must be between 0 and 10. This parameter is used together with backgroundImage.

final

hashCode → int

The hash code for this object.

no setter, inherited

height → int?

Total height of the video stream in pixels. Default is 640. For video streams, the value range is 64,1080. If the value is less than 64, it is automatically adjusted to 64 by the Agora server; if it is greater than 1080, it is adjusted to 1080. For audio-only streams, set both width and height to 0.

final

lowLatency → bool?

Deprecated. Not recommended. Low latency mode true : Low latency, video quality not guaranteed. false : (Default) High latency, video quality guaranteed.

final

metadata → String?

Metadata sent to the CDN client. Deprecated. Not recommended.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transcodingExtraInfo → String?

Reserved parameter: Custom information sent to the CDN streaming client, used to populate SEI frames in H264/H265 video. Length limit: 4096 bytes.

final

transcodingUsers → List<TranscodingUser>?

Users participating in video mixing for CDN live streaming. Supports up to 17 users simultaneously. See TranscodingUser.

final

userCount → int?

Number of users in the video mix. Default is 0. Value range is 0,17.

final

videoBitrate → int?

Video encoding bitrate in Kbps. You do not need to set this parameter. Keep the default value standardBitrate. The SDK automatically matches the most appropriate bitrate based on the video resolution and frame rate you set. For the mapping between resolution and frame rate, see Video Profile.

final

videoCodecProfile → VideoCodecProfileType?

Encoding profile of the output video for CDN live streaming. Can be set to 66, 77, or 100. See VideoCodecProfileType. If you set this parameter to other values, the Agora server adjusts it to the default value.

final

videoCodecType → VideoCodecTypeForStream?

Codec type of the output video for CDN live streaming. See VideoCodecTypeForStream.

final

videoFramerate → int?

Frame rate of the output video for CDN live streaming. Value range is (0,30], in fps. Default is 15 fps. The Agora server adjusts any value above 30 fps to 30 fps.

final

videoGop → int?

GOP (Group of Pictures) of the output video for CDN live streaming, in frames. Default is 30.

final

watermark → List<RtcImage>?

Watermark on the live video. The image format must be PNG. See RtcImage. You can add one watermark or use an array to add multiple watermarks.

final

watermarkCount → int?

Number of watermarks on the live video. The total number of watermarks and background images must be between 0 and 10. This parameter is used together with watermark.

final

width → int?

Total width of the video stream in pixels. Default is 360. For video streams, the value range is 64,1920. If the value is less than 64, it is automatically adjusted to 64 by the Agora server; if it is greater than 1920, it is adjusted to 1920. For audio-only streams, set both width and height to 0.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited