Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TranscodingUser

The video and audio properties of the user displaying the video in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN streaming channel.

Hierarchy

  • TranscodingUser

Index

Constructors

Properties

Constructors

constructor

  • new TranscodingUser(uid: number, x: number, y: number, width: number, height: number, zOrder: number, alpha?: number, audioChannel: number): TranscodingUser

  • Parameters

    • uid: number
    • x: number
    • y: number
    • width: number
    • height: number
    • zOrder: number
    • Default value alpha: number = 1
    • audioChannel: number

    Returns TranscodingUser

Properties

alpha

alpha: number

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

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

audioChannel

audioChannel: number

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 are 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 are 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 are 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 are 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 are mixed into mono first.
note

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

height

height: number

Height (pixel) of the video frame. The default value is 640.

uid

uid: number

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

width

width: number

Width (pixel) of the video frame. The default value is 360.

x

x: number

Horizontal position (pixel) of the video frame relative to the top left corner.

y

y: number

Vertical position (pixel) of the video frame relative to the top left corner.

zOrder

zOrder: number

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 ERR_INVALID_ARGUMENT.
  • As of v3.1.2, the SDK supports zOrder = 0.

Generated using TypeDoc