Package io.agora.rtc2.live

Class LiveTranscoding

java.lang.Object
io.agora.rtc2.live.LiveTranscoding
public class LiveTranscoding extends Object

  • Field Details

    • width

      public int width
      The width of the video in pixels. The default value is 360. - When pushing video streams to the CDN, the value range of `width` is [64,1920]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1920, Agora server automatically adjusts it to 1920. - When pushing audio streams to the CDN, set `width` and `height` as 0.

    • height

      public int height
      The height of the video in pixels. The default value is 640. - When pushing video streams to the CDN, the value range of` height` is [64,1080]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1080, Agora server automatically adjusts it to 1080. - When pushing audio streams to the CDN, set `width` and `height` as 0.

    • videoBitrate

      public int videoBitrate
      The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value `STANDARD_BITRATE` is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution and frame rate, see `Video profile`.

    • videoFramerate

      public int videoFramerate
      Frame rate (fps) of the output video stream set for Media Push. The default value is 15. The value range is (0,30].

    • lowLatency

      @Deprecated public boolean lowLatency
      Deprecated.
      Deprecated as of v2.8.0. Agora does not recommend using this parameter.
      Latency mode: - `true`: Low latency with unassured quality. - `false`: (Default) High latency with assured quality.

    • videoGop

      public int videoGop
      GOP (Group of Pictures) in fps of the video frames for Media Push. The default value is 30.

    • audioSampleRate

      public LiveTranscoding.AudioSampleRateType audioSampleRate
      The audio sampling rate (Hz) of the output media stream. See `AudioSampleRateType`.

    • audioBitrate

      public int audioBitrate
      Bitrate (Kbps) of the audio output stream for Media Push. The default value is 48, and the highest value is 128.

    • audioChannels

      public int audioChannels
      The number of audio channels for Media Push. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5. - 1: (Default) Mono. - 2: Stereo. - 3: Three audio channels. - 4: Four audio channels. - 5: Five audio channels.

    • audioCodecProfile

      public LiveTranscoding.AudioCodecProfileType audioCodecProfile
      Audio codec profile type for Media Push. See `AudioCodecProfileType`.

    • videoCodecProfile

      public LiveTranscoding.VideoCodecProfileType videoCodecProfile
      Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See `VideoCodecProfileType` for details.

    • videoCodecType

      public LiveTranscoding.VideoCodecType videoCodecType
      Video codec profile types for Media Push. See `VideoCodecType`.

    • userCount

      @Deprecated public int userCount
      Deprecated.
      This parameter is deprecated. We recommend using the getUserCount method.
      Obsolete and not recommended for use. Use `getUserCount` instead. The number of users in the Media Push. The value range is [0,17].

    • backgroundColor

      @Deprecated public int backgroundColor
      Deprecated.
      This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.
      Obsolete and not recommended for use. Use `setBackgroundColor [1/2]` instead.

    • userConfigExtraInfo

      public String userConfigExtraInfo
      Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 bytes. For more information on SEI, see SEI-related questions.

    • metadata

      @Deprecated public String metadata
      Deprecated.
      This parameter is deprecated.
      Obsolete and not recommended for use. The metadata sent to the CDN client.

  • Constructor Details

    • LiveTranscoding

      public LiveTranscoding()

  • Method Details

    • addWatermark

      public void addWatermark(AgoraImage watermark)
      add watermark to list
      Parameters:
      watermark - you want to add watermark.

    • removeWatermark

      public boolean removeWatermark(AgoraImage watermark)
      remove watermark from list
      Parameters:
      watermark - you want to remove object.
      Returns:
      if success, will return true. Otherwise, will return false.

    • getWatermarkList

      public ArrayList<AgoraImage> getWatermarkList()
      get object attribute of watermarkList
      Returns:
      watermark list

    • addBackgroundImage

      public void addBackgroundImage(AgoraImage backgroundImage)
      add background image to backgroundImageList
      Parameters:
      backgroundImage - you want to add background to list.

    • removeBackgroundImage

      public boolean removeBackgroundImage(AgoraImage backgroundImage)
      remove background from background image list
      Parameters:
      backgroundImage - you want to remove background image
      Returns:
      if success to remove, will return true. Otherwise, will return false.

    • getBackgroundImageList

      public ArrayList<AgoraImage> getBackgroundImageList()
      get object attribute of backgroundImageList
      Returns:
      backgroundImage list

    • setAdvancedFeatures

      public void setAdvancedFeatures(String featureName, Boolean opened)
      Enables/Disables advanced features of the RTMP or RTMPS streaming with transcoding.
      Parameters:
      featureName - The name of the advanced feature. It contains LBHQ and VEO.
      opened - Whether to enable the advanced feature: - `true`: Enable the advanced feature. - `false`: (Default) Disable the advanced feature.

    • getAdvancedFeatures

      public Map<String,Boolean> getAdvancedFeatures()
      Checks whether advanced features of the RTMP or RTMPS streaming with transcoding are enabled.
      Returns:
      The name of each advanced feature and whether the advanced feature is enabled.

    • addUser

      public int addUser(LiveTranscoding.TranscodingUser user)
      Adds a user displaying the video in CDN live.
      Parameters:
      user - transcodingUser.
      Returns:
      • 0: Success.
      • <0: Failure.

    • getUsers

      public final ArrayList<LiveTranscoding.TranscodingUser> getUsers()
      Gets the user list in CDN live. This method retrieves all users in CDN live. The user list returned by this method is read-only and should not be modified.
      Returns:
      User list in a array.

    • setUsers

      public void setUsers(ArrayList<LiveTranscoding.TranscodingUser> users)
      Sets the users in batches in CDN live. This method sets all users involved in the CDN live stream. This method replaces the old user data with the new user data.
      Parameters:
      users - All users involved in CDN live.

    • setUsers

      public void setUsers(Map<Integer,LiveTranscoding.TranscodingUser> users)
      Sets the users in batches in CDN live. This method sets all users involved in CDN live. This method replaces the old user data with the the new user data.
      Parameters:
      users - All users involved in CDN live.

    • removeUser

      public int removeUser(int uid)
      Removes a user from CDN live.
      Parameters:
      uid - User ID of the user to remove from CDN live.
      Returns:
      • 0: Success.
      • < 0: Failure.

    • getUserCount

      public int getUserCount()
      Gets the number of users transcoded in CDN live.
      Returns:
      Number of users transcoded in CDN live.

    • getBackgroundColor

      public int getBackgroundColor()
      Gets the background color in hex.
      Returns:
      Background color to set in RGB hex value.

    • setBackgroundColor

      public void setBackgroundColor(int color)
      Sets the background color of the CDN live stream in the format of RGB hex.
      Parameters:
      color - Background color to set in RGB hex value. Value only, do not include a #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).

    • setBackgroundColor

      public void setBackgroundColor(int red, int green, int blue)
      Sets the background color in RGB format.
      Parameters:
      red - Red component.
      green - Green component.
      blue - Blue component.

    • getRed

      @Deprecated public int getRed()
      Deprecated.
      Gets the background color's red component.
      Returns:
      Background color's red component.

    • getGreen

      @Deprecated public int getGreen()
      Deprecated.
      Gets the background color's green component.
      Returns:
      Background color's green component.

    • getBlue

      @Deprecated public int getBlue()
      Deprecated.
      Gets the background color's blue component.
      Returns:
      Background color's blue component.

    • setRed

      @Deprecated public void setRed(int red)
      Deprecated.
      Sets the background color's red component.

    • setGreen

      @Deprecated public void setGreen(int green)
      Deprecated.
      Sets the background color's green component.

    • setBlue

      @Deprecated public void setBlue(int blue)
      Deprecated.
      Sets the background color's blue component.