Agora RTC Objective-C API Reference  Refactor
Data Structures | Typedefs
AgoraObjects.h File Reference

Go to the source code of this file.

Data Structures

class  AgoraMediaSource
 
class  AgoraMediaPlayerCacheStatistics
 
class  AgoraMediaPlayerUpdatedInfo
 
class  AgoraMediaPlayerSrcInfo
 
class  AgoraDirectCdnStreamingStats
 
class  AgoraDirectCdnStreamingMediaOptions
 
class  AgoraEncodedVideoTrackOptions
 
class  AgoraRtcChannelMediaOptions
 
class  AgoraRtcVideoCanvas
 
class  AgoraLastmileProbeConfig
 
class  AgoraLastmileProbeOneWayResult
 
class  AgoraLastmileProbeResult
 
class  AgoraRtcRemoteVideoStats
 
class  AgoraRtcLocalAudioStats
 
class  AgoraRtcRemoteAudioStats
 
class  AgoraRtcAudioVolumeInfo
 
class  AgoraChannelStats
 
class  AgoraLiveStreamAdvancedFeature
 
class  WatermarkOptions
 
class  AgoraVideoFrame
 
class  AgoraLogConfig
 
class  AgoraRtcEngineConfig
 
class  AgoraAudioFrame
 
class  AgoraEncodedAudioFrameInfo
 
class  AgoraUplinkNetworkInfo
 
class  AgoraDownlinkNetworkInfo
 
class  AgoraLeaveChannelOptions
 
class  AgoraOutputVideoFrame
 
class  AgoraEncryptionConfig
 
class  AgoraUserInfo
 
class  AgoraClientRoleOptions
 
class  AgoraCameraCapturerConfiguration
 
class  AgoraDataStreamConfig
 
class  AgoraChannelMediaRelayInfo
 
class  AgoraChannelMediaRelayConfiguration
 
class  AgoraBeautyOptions
 
class  AgoraVideoDenoiserOptions
 
class  AgoraLowlightEnhanceOptions
 
class  AgoraColorEnhanceOptions
 
class  AgoraVirtualBackgroundSource
 
class  AgoraSegmentationProperty
 
class  AgoraTranscodingVideoStream
 
class  AgoraLocalTranscoderConfiguration
 
class  AgoraScreenCaptureParameters
 
class  AgoraScreenVideoParameters
 
class  AgoraScreenAudioParameters
 
class  AgoraScreenCaptureParameters2
 
class  AgoraAudioRecordingConfiguration
 
class  AgoraSimulcastStreamConfig
 
class  AgoraRtcMediaStreamInfo
 
class  AgoraAudioSpectrumInfo
 
class  AgoraAudioEncodedFrameDelegateConfig
 
class  AgoraContentInspectModule
 
class  AgoraContentInspectConfig
 
class  AgoraRtcConnection
 
class  AgoraVideoSubscriptionOptions
 
class  AgoraEncodedVideoFrameInfo
 
class  AgoraLocalAccessPointConfiguration
 
class  AgoraRhythmPlayerConfig
 
class  AgoraFacePositionInfo
 
class  AgoraAdvancedAudioOptions
 
class  AgoraImageTrackOptions
 
class  AgoraEchoTestConfiguration
 
class  AgoraWlAccStats
 
class  AgoraMediaRecorderInfo
 
class  AgoraMediaRecorderConfiguration
 

Typedefs

typedef int(^ AgoraRtcMediaPlayerCustomSourceOnReadCallback) (id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, unsigned char *_Nullable buffer, int bufferSize)
 
typedef long long(^ AgoraRtcMediaPlayerCustomSourceOnSeekCallback) (id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, long long offset, int whence)
 

Typedef Documentation

◆ VIEW_CLASS

typedef UIView VIEW_CLASS

◆ COLOR_CLASS

typedef UIColor COLOR_CLASS

◆ IMAGE_CLASS

typedef UIImage IMAGE_CLASS

◆ AgoraRtcMediaPlayerCustomSourceOnReadCallback

typedef int(^ AgoraRtcMediaPlayerCustomSourceOnReadCallback) (id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, unsigned char *_Nullable buffer, int bufferSize)

The player requests to read the data callback, you need to fill the specified length of data into the buffer.

Parameters
playerKitthe player instance. AgoraRtcMediaPlayerProtocol.
bufferthe buffer pointer that you need to fill data.
bufferSizethe bufferSize need to fill of the buffer pointer.
Returns
you need return offset value if succeed. return 0 if failed.

◆ AgoraRtcMediaPlayerCustomSourceOnSeekCallback

typedef long long(^ AgoraRtcMediaPlayerCustomSourceOnSeekCallback) (id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, long long offset, int whence)

The Player seek event callback, you need to operate the corresponding stream seek operation, You can refer to the definition of lseek() at https://man7.org/linux/man-pages/man2/lseek.2.html.

Parameters
playerKitthe player instance. AgoraRtcMediaPlayerProtocol.
offsetthe value of seek offset,
whencethe postion of start seeking, the directive whence as follows: SEEK_SET : The file offset is set to offset bytes. SEEK_CUR : The file offset is set to its current location plus offset bytes. SEEK_END : The file offset is set to the size of the file plus offset bytes. 65536 - AVSEEK_SIZE : Optional. Passing this as the "whence" parameter to a seek function causes it to return the filesize without seeking anywhere.
Returns
whence == 65536, return filesize if you need. whence >= 0 && whence < 3 , return offset value if succeed. return -1 if failed.