TranscodingUser class

Settings for each host involved in transcoding and mixing.

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

Properties

alpha → double?
Transparency of the host video. Value range: 0.0, 1.0. 0.0: Fully transparent. 1.0: (Default) Fully opaque.
final
audioChannel → int?
When the value is not 0, a special player is required. Audio channel occupied by the host audio in the output audio. Default is 0. Value range: 0,5: 0 : (Recommended) Default audio mixing setting, supports up to stereo, related to the host's upstream audio. 1 : Host audio in the FL channel of the output audio. If the host's upstream audio is multi-channel, the Agora server mixes it into mono. 2 : Host audio in the FC channel of the output audio. If the host's upstream audio is multi-channel, the Agora server mixes it into mono. 3 : Host audio in the FR channel of the output audio. If the host's upstream audio is multi-channel, the Agora server mixes it into mono. 4 : Host audio in the BL channel of the output audio. If the host's upstream audio is multi-channel, the Agora server mixes it into mono. 5 : Host audio in the BR channel of the output audio. If the host's upstream audio is multi-channel, the Agora server mixes it into mono. 0xFF or values greater than 5 : The host audio is muted, and the Agora server removes the host's audio.
final
hashCode → int
The hash code for this object.
no setterinherited
height → int?
Height of the host video (px).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
uid → int?
User ID of the host.
final
width → int?
Width of the host video (px).
final
x → int?
X-coordinate (px) of the host video in the output video, with the top-left corner of the output video as the origin. Value range: 0, width, where width is set in LiveTranscoding.
final
y → int?
Y-coordinate (px) of the host video in the output video, with the top-left corner of the output video as the origin. Value range: 0, height, where height is set in LiveTranscoding.
final
zOrder → int?
If the value is less than 0 or greater than 100, an errInvalidArgument error is returned. Setting zOrder to 0 is supported. Layer number of the host video. Value range: 0,100. 0: (Default) Video is at the bottom layer. 100: Video is at the top layer.
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