Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKAudioRawData Class Reference

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

#include <ZMVideoSDKAudioHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - canAddRef
 Determines if adding a reference to the interface pointer is supported.
 
(BOOL) - addRef
 Adds one to the reference count.
 
(int) - releaseRef
 Subtract one from the reference count.
 

Properties

char * buffer
 Buffer data.
 
unsigned int bufferLen
 Buffer length of this data.
 
unsigned int sampleRate
 Sample rate of this data.
 
unsigned int channelNum
 Channel number of this data.
 
long long timeStamp
 Millisecond timestamp.
 

Detailed Description

Represents raw audio data received from the SDK.

Definition at line 16 of file ZMVideoSDKAudioHelper.h.

Method Documentation

◆ addRef

- (BOOL) addRef

Adds one to the reference count.

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

◆ canAddRef

- (BOOL) canAddRef

Determines if adding a reference to the interface pointer is supported.

Returns
If adding a reference is supported, it returns YES. Otherwise, NO.
Note
If addRef is called, the SDK will try to hold the raw data buffer until the reference becomes 0. When finished using the raw data buffer, call releaseRef to release it.

◆ releaseRef

- (int) releaseRef

Subtract one from the reference count.

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

Property Documentation

◆ buffer

- (char*) buffer
readnonatomicassign

Buffer data.

Definition at line 21 of file ZMVideoSDKAudioHelper.h.

◆ bufferLen

- (unsigned int) bufferLen
readnonatomicassign

Buffer length of this data.

Definition at line 26 of file ZMVideoSDKAudioHelper.h.

◆ channelNum

- (unsigned int) channelNum
readnonatomicassign

Channel number of this data.

Definition at line 36 of file ZMVideoSDKAudioHelper.h.

◆ sampleRate

- (unsigned int) sampleRate
readnonatomicassign

Sample rate of this data.

Definition at line 31 of file ZMVideoSDKAudioHelper.h.

◆ timeStamp

- (long long) timeStamp
readnonatomicassign

Millisecond timestamp.

Definition at line 40 of file ZMVideoSDKAudioHelper.h.