Package io.agora.rtc2.live

Class LiveTranscoding.TranscodingUser

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    alpha
    The transparency of the host's video.
    int
    audioChannel
    The audio channel used by the host's audio in the output audio.
    int
    height
    The height (pixel) of the host's video.
    int
    uid
    The user ID of the host.
    String
    userId
     
    int
    width
    The width (pixel) of the host's video.
    int
    x
    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).
    int
    y
    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).
    int
    zOrder
    The layer index number of the host's video.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TranscodingUser()
     

  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • uid

      public int uid
      The user ID of the host.

    • userId

      public String userId

    • x

      public int x
      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 `width` set in `LiveTranscoding`.

    • y

      public int y
      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 `height` set in `LiveTranscoding`.

    • width

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

    • height

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

    • zOrder

      public int zOrder
      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.

    • alpha

      public float alpha
      The transparency of the host's video. The value range is [0.0,1.0]. - 0.0: Completely transparent. - 1.0: (Default) Opaque.

    • audioChannel

      public int 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.

  • Constructor Details

    • TranscodingUser

      public TranscodingUser()