ZoomVideoSDKAudioRawData Class Reference

A class that contains the information of audio raw data. More...

#include <ZoomVideoSDKAudioRawData.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canAddRef
	Determines whether the reference count for the interface pointer can be increased.
(BOOL)	- addRef
	Increases reference count by 1. Adding a reference will ensure that the raw data buffer will not be released.
(NSInteger)	- releaseRef
	Decreases reference count by 1.

Properties
char *	buffer
	Gets the pointer of audio buffer data.
NSInteger	bufferLen
	Gets the audio buffer data length.
NSInteger	sampleRate
	Gets the audio sampling rate.
NSInteger	channelNum
	Gets the number of audio channels.
NSDate *	timeStamp
	Gets the timestamp of audio data.

Detailed Description

A class that contains the information of audio raw data.

Definition at line 12 of file ZoomVideoSDKAudioRawData.h.

Method Documentation

addRef

- (BOOL) addRef

Increases reference count by 1. Adding a reference will ensure that the raw data buffer will not be released.

Returns

YES if the function succeeds. Otherwise, NO.

Warning

If you addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef.

canAddRef

- (BOOL) canAddRef

Determines whether the reference count for the interface pointer can be increased.

Returns

YES if the reference count can be increased. Otherwise, NO.

Warning

If you call addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef to release it.

releaseRef

- (NSInteger) releaseRef

Decreases reference count by 1.

Returns

The current reference count after release.

Warning

If you addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef.

Property Documentation

buffer

- (char*) buffer

readwritenonatomicassign

Gets the pointer of audio buffer data.

Definition at line 17 of file ZoomVideoSDKAudioRawData.h.

bufferLen

- (NSInteger) bufferLen

readwritenonatomicassign

Gets the audio buffer data length.

Definition at line 22 of file ZoomVideoSDKAudioRawData.h.

channelNum

- (NSInteger) channelNum

readwritenonatomicassign

Gets the number of audio channels.

Definition at line 32 of file ZoomVideoSDKAudioRawData.h.

sampleRate

- (NSInteger) sampleRate

readwritenonatomicassign

Gets the audio sampling rate.

Definition at line 27 of file ZoomVideoSDKAudioRawData.h.

timeStamp

- (NSDate*) timeStamp

readwritenonatomicstrong

Gets the timestamp of audio data.

Definition at line 37 of file ZoomVideoSDKAudioRawData.h.