TranscodingUser class

Transcoding configurations of each host.

Annotations

• @JsonSerializable(explicitToJson: true)

Constructors

TranscodingUser(int uid, {int? x, int? y, int? width, int? height, int? zOrder, double? alpha, AudioChannel? audioChannel})

Constructs the TranscodingUser.

Properties

alpha ↔ double?

The transparency of the host's video. The value range is 0.0, 1.0. 0.0: Completely transparent. 1.0: (Default) Opaque.

getter/setter pair

audioChannel ↔ AudioChannel?

The audio channel used by the host's audio in the output audio. The default value is 0, and the value range is 0, 5. 0: (Recommended) The defaut setting, which supports dual channels at most and depends on the upstream of the host. 1: The host's audio uses the FL audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first. 2: The host's audio uses the FC audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first. 3: The host's audio uses the FR audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first. 4: The host's audio uses the BL audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first. 5: The host's audio uses the BR audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first. 0xFF or a value greater than 5: The host's audio is muted, and the Agora server removes the host's audio. If the value is not 0, a special player is required.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ int?

The height (pixel) of the host's video.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

uid ↔ int

The user ID of the host.

getter/setter pair

width ↔ int?

The width (pixel) of the host's video.

getter/setter pair

x ↔ int?

The x coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is 0, width, where width is the LiveTranscoding width set in .

getter/setter pair

y ↔ int?

The y coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is 0, height, where height is the LiveTranscoding height set in .

getter/setter pair

zOrder ↔ int?

The layer index number of the host's video. The value range is 0, 100. 0: (Default) The host's video is the bottom layer. 100: The host's video is the top layer. If the value is beyond this range, the SDK reports the error code ERR_INVALID_ARGUMENT. As of v2.3, the SDK supports setting zOrder to 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