LiveTranscoding class

Transcoding configurations for Media Push.

Annotations

• @JsonSerializable(explicitToJson: true)

Constructors

LiveTranscoding(List<TranscodingUser> transcodingUsers, {int? width, int? height, int? videoBitrate, VideoFrameRate? videoFramerate, bool? lowLatency, int? videoGop, List<AgoraImage>? watermark, List<AgoraImage>? backgroundImage, AudioSampleRateType? audioSampleRate, int? audioBitrate, AudioChannel? audioChannels, AudioCodecProfileType? audioCodecProfile, VideoCodecProfileType? videoCodecProfile, int? backgroundColor, VideoCodecTypeForStream? videoCodecType, String? userConfigExtraInfo})

Constructs the LiveTranscoding.

Properties

audioBitrate ↔ int?

Bitrate (Kbps) of the audio output stream for Media Push. The default value is 48, and the highest value is 128.

getter/setter pair

audioChannels ↔ AudioChannel?

The number of audio channels for Media Push. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5. 1: (Default) Mono 2: Stereo. 3: Three audio channels. 4: Four audio channels. 5: Five audio channels.

getter/setter pair

audioCodecProfile ↔ AudioCodecProfileType?

Audio codec profile type for Media Push. See AudioCodecProfileType for details.

getter/setter pair

audioSampleRate ↔ AudioSampleRateType?

Self-defined audio sample rate. See AudioSampleRateType for details.

getter/setter pair

backgroundColor ↔ int?

The background color in RGB hex value. Value only. Do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).

getter/setter pair

backgroundImage ↔ List<AgoraImage>?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ int?

The height of the video in pixels. The default value is 640. When pushing video streams to the CDN, the value range of height is 64,1080. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1080, Agora server automatically adjusts it to 1080. When pushing audio streams to the CDN, set width and height as 0.

getter/setter pair

lowLatency ↔ bool?

Deprecated This parameter is deprecated. Latency mode: true: Low latency with unassured quality. false: (Default) High latency with assured quality.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transcodingUsers ↔ List<TranscodingUser>

Manages the user layout configuration in the CDN live streaming. Agora supports a maximum of 17 transcoding users in a Media Push channel. See TranscodingUser for details.

getter/setter pair

userConfigExtraInfo ↔ String?

getter/setter pair

videoBitrate ↔ int?

Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps. Set this parameter according to the Video profile table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range. You can refer to Media Pushfor how to set this parameter.

getter/setter pair

videoCodecProfile ↔ VideoCodecProfileType?

Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See VideoCodecProfileType for details. If you set this parameter to any other value, Agora adjusts it to the default value.

getter/setter pair

videoCodecType ↔ VideoCodecTypeForStream?

Video codec profile types for Media Push. See VideoCodecTypeForStream for details.

getter/setter pair

videoFramerate ↔ VideoFrameRate?

Frame rate (in fps) of the output video stream set for Media Push. The default value is 15 , and the value range is (0,30]. The Agora server adjusts any value over 30 to 30.

getter/setter pair

videoGop ↔ int?

GOP (Group of Pictures) in fps of the video frames for Media Push. The default value is 30.

getter/setter pair

watermark ↔ List<AgoraImage>?

The watermark on the live video. Watermark images must be in the PNG format. See AgoraImage for details. You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.

getter/setter pair

width ↔ int?

The width of the video in pixels. The default value is 360. When pushing video streams to the CDN, the value range of width is 64,1920. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1920, Agora server automatically adjusts it to 1920. When pushing audio streams to the CDN, set width and height as 0.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited