Agora Java API Reference for Android
Public Member Functions | List of all members
agora::rtc::IMediaControlPacketSender Class Referenceabstract

#include <NGIAgoraMediaNode.h>

Public Member Functions

virtual int sendPeerMediaControlPacket (media::base::user_id_t userId, const uint8_t *packet, size_t length)=0
 
virtual int sendBroadcastMediaControlPacket (const uint8_t *packet, size_t length)=0
 

Detailed Description

The IMediaControlPacketSender class.

You can get the IMediaControlPacketSender class object from a video track or audio track, and then send media control packets directly. The media control packets are RTCP/UDP packets that contain media control payload. If the track is disabled, the packets will be automatically discarded.

Member Function Documentation

◆ sendPeerMediaControlPacket()

virtual int agora::rtc::IMediaControlPacketSender::sendPeerMediaControlPacket ( media::base::user_id_t  userId,
const uint8_t *  packet,
size_t  length 
)
pure virtual

Sends the media control packet to a specified user. Currently, we only support sending packets through video tracks.

Parameters
userIdID of the user to send the packet to.
packetThe pointer to the packet.
lengthThe packet size.
Returns
  • true: Success.
  • false: Failure.

◆ sendBroadcastMediaControlPacket()

virtual int agora::rtc::IMediaControlPacketSender::sendBroadcastMediaControlPacket ( const uint8_t *  packet,
size_t  length 
)
pure virtual

Sends the media transport control packet to all users. Currently, we only support sending packets through video tracks.

Parameters
packetThe pointer to the packet.
lengthThe packet size.
Returns
  • true: Success.
  • false: Failure.