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

Provides APIs to send video and audio data to the production studio. More...

#include <ZoomSDKMeetingProductionStudioController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- sendVideoFrame:width:height:frameLength:format:
 Sends video to production studio.
 
(ZoomSDKError- sendAudio:dataLength:sampleRate:channel:
 Sends audio to production studio.
 

Detailed Description

Provides APIs to send video and audio data to the production studio.

Definition at line 13 of file ZoomSDKMeetingProductionStudioController.h.

Method Documentation

◆ sendAudio:dataLength:sampleRate:channel:

- (ZoomSDKError) sendAudio: (char *) data
dataLength: (unsigned int) length
sampleRate: (int) rate
channel: (ZoomSDKAudioChannel) channel 

Sends audio to production studio.

Parameters
dataThe audio data's address.
lengthThe audio data's length, in even numbers.
rateThe audio data's sampling rate.
channelThe channel type, default is ZoomSDKAudioChannel_Mono.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ sendVideoFrame:width:height:frameLength:format:

- (ZoomSDKError) sendVideoFrame: (char *) frameBuffer
width: (unsigned int) width
height: (unsigned int) height
frameLength: (unsigned int) frameLength
format: (ZoomSDKFrameDataFormat) format 

Sends video to production studio.

Parameters
frameBufferThe data to send.
widthThe data's width to send.
heightThe data's height to send.
frameLengthThe data's length to send.
formatThe format of frame data.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.
Note
The video's width and height data sent are same with the width and height in ZoomSDKPSVideoSourceCapability, which is passed in when calling startPSMode. If they are not same, returns ZoomSDKError_InvalidParameter.