Public Attributes | |
| int | uid |
| int | x |
| int | y |
| int | width |
| int | height |
| int | zOrder |
| float | alpha |
| int | audioChannel |
Detailed Description
The transcodingUser Class which defines the video properties of the user displaying the video in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN streaming channel.
Member Data Documentation
◆ uid
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.uid |
ID of the user in the CDN streaming.
◆ x
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.x |
Horizontal position of the video frame of the user from the top left corner of the CDN streaming.
◆ y
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.y |
Vertical position of the video frame of the user from the top left corner of the CDN streaming.
◆ width
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.width |
Width of the video frame of the user on the CDN streaming. The default value is 360.
◆ height
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.height |
Height of the video frame of the user on the CDN streaming. The default value is 640.
◆ zOrder
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.zOrder |
Layer position of video frame of the user on the CDN streaming that ranges between 0 and 100. From v2.3.0, Agora SDK supports setting zOrder as 0.
- The smallest value is 0 (also default value), which means that the video frame is at the bottom layer.
- The biggest value is 100, which means that the video frame is at the top layer.
Note: If the value is set lower than 0 or higher than 100, the ERR_INVALID_ARGUMENT error will be reported.
◆ alpha
| float io.agora.rtc.live.LiveTranscoding.TranscodingUser.alpha |
The transparency of the video frame of the user on the CDN streaming that ranges between 0.0 and 1.0. 0.0 means that the video frame is completely transparent and 1.0 opaque. The default value is 1.0.
◆ audioChannel
| int io.agora.rtc.live.LiveTranscoding.TranscodingUser.audioChannel |
The audio channel of the sound ranging between 0 and 5. The default value is 0.
- 0: (default) Supports dual channels. Depends on the upstream of the broadcaster.
- 1: The audio stream of the broadcaster uses the FL audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels will be mixed into mono first.
- 2: The audio stream of the broadcaster uses the FC audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels will be mixed into mono first.
- 3: The audio stream of the broadcaster uses the FR audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels will be mixed into mono first.
- 4: The audio stream of the broadcaster uses the BL audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels will be mixed into mono first.
- 5: The audio stream of the broadcaster uses the BR audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels will be mixed into mono first.
- Note
- Special players are needed if it is not set to 0:
