Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAudioRawData Class Reference

Represents audio raw data received from the SDK. More...

#include <ZoomSDKRawDataController.h>

Inherits NSObject.

Instance Methods

(BOOL) - canAddRef
 Gets if this object can add ref.
 
(BOOL) - addRef
 Adds reference for this object, if you doesn't add ref, this object is released when the callback response ends.
 
(int) - releaseData
 Release the object, if you has add ref, remeber to call this api to release when you wantn't to use this object.
 
(char *_Nullable) - getBuffer
 Gets the buffer data.
 
(unsigned int) - getBufferLen
 Gets the buffer length of this data.
 
(unsigned int) - getSampleRate
 Gets the sample rate of this data.
 
(unsigned int) - getChannelNum
 Gets the channel number of this data.
 
(long long) - getTimeStamp
 Gets the raw's timestamp data.
 

Detailed Description

Represents audio raw data received from the SDK.

Definition at line 23 of file ZoomSDKRawDataController.h.

Method Documentation

◆ addRef

- (BOOL) addRef

Adds reference for this object, if you doesn't add ref, this object is released when the callback response ends.

Returns
If the function succeeds, it returns YES. Otherwise, NO.

◆ canAddRef

- (BOOL) canAddRef

Gets if this object can add ref.

Returns
If can add ref, it returns YES. Otherwise, NO.

◆ getBuffer

- (char *_Nullable) getBuffer

Gets the buffer data.

Returns
If the function succeeds, it returns the buffer data. Otherwise, this function fails and returns nil.

◆ getBufferLen

- (unsigned int) getBufferLen

Gets the buffer length of this data.

Returns
If the function succeeds, it returns the buffer length of this data. Otherwise, returns 0.

◆ getChannelNum

- (unsigned int) getChannelNum

Gets the channel number of this data.

Returns
If the function succeeds, it returns the channel number of this data. Otherwise, returns 0.

◆ getSampleRate

- (unsigned int) getSampleRate

Gets the sample rate of this data.

Returns
If the function succeeds, it returns the sample rate of this data. Otherwise, returns 0.

◆ getTimeStamp

- (long long) getTimeStamp

Gets the raw's timestamp data.

Returns
If the function succeeds, it returns the millisecond timestamp. Otherwise, returns 0.

◆ releaseData

- (int) releaseData

Release the object, if you has add ref, remeber to call this api to release when you wantn't to use this object.

Returns
If the function succeeds, it returns reference count of this object. Otherwise, returns -1.