Class LiveTranscoding.TranscodingUser

java.lang.Object
io.agora.rtc2.live.LiveTranscoding.TranscodingUser
Enclosing class:
LiveTranscoding

public static class LiveTranscoding.TranscodingUser extends Object
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 live streaming channel.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    The transparency level of the user's video that ranges between 0.0 and 1.0.
    int
    The audio channel ranging between 0 and 5.
    int
    Height of the video frame of the user on the CDN live streaming.
    int
    ID of the user in the CDN live streaming.
     
    int
    Width of the video frame of the user on the CDN live streaming.
    int
    Horizontal position of the video frame of the user from the top left corner of the CDN live streaming.
    int
    Vertical position of the video frame of the user from the top left corner of the CDN live streaming.
    int
    The layer index of the video frame.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • uid

      public int uid
      ID of the user in the CDN live streaming.
    • userId

      public String userId
    • x

      public int x
      Horizontal position of the video frame of the user from the top left corner of the CDN live streaming.
    • y

      public int y
      Vertical position of the video frame of the user from the top left corner of the CDN live streaming.
    • width

      public int width
      Width of the video frame of the user on the CDN live streaming. The default value is 360.
    • height

      public int height
      Height of the video frame of the user on the CDN live streaming. The default value is 640.
    • zOrder

      public int zOrder
      The layer index of the video frame. An integer. The value range is [0,100]. - 0: (Default) Bottom layer. - 100: Top layer.

      Note: If the value is set lower than 0 or higher than 100, the ERR_INVALID_ARGUMENT error is reported.

    • alpha

      public float alpha
      The transparency level of the user's video that ranges between 0.0 and 1.0. 0.0 means that the video frame is completely transparent and 1.0 means opaque. The default value is 1.0.
    • audioChannel

      public int audioChannel
      The audio channel 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 are 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 are 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 are 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 are 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 are mixed into mono first.
  • Constructor Details

    • TranscodingUser

      public TranscodingUser()