Agora Unity SDK API Reference

The transparency level of the user's video. The value ranges between 0 and 1.0:

• 0: Completely transparent
• 1.0: (Default) Opaque

The audio channel of the sound. The default value is 0:

• 0: (Default) Supports dual channels at most, depending on the upstream of the host.
• 1: The audio stream of the host uses the FL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 2: The audio stream of the host uses the FC audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 3: The audio stream of the host uses the FR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 4: The audio stream of the host uses the BL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 5: The audio stream of the host uses the BR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.

Note

If your setting is not 0, you may need a specialized player.

Height of the video frame. The default value is 640.

User ID of the user displaying the video in the CDN live.

Width of the video frame. The default value is 360.

Horizontal position from the top left corner of the video frame.

Vertical position from the top left corner of the video frame.

The layer index of the video frame. An integer. The value range is [0, 100].

• 0: (Default) Bottom layer.
• 100: Top layer.

Note

• If zOrder is beyond this range, the SDK reports the ERR_INVALID_ARGUMENT(-2).
• As of v2.3, the SDK supports zOrder = 0.