Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKLiveStreamHelper Class Referenceabstract

Live stream helper interface. More...

#include <zoom_video_sdk_livestream_helper_interface.h>

Public Member Functions

virtual ZoomVideoSDKErrors startLiveStream (const zchar_t *streamUrl, const zchar_t *key, const zchar_t *broadcastUrl)=0
 Start live stream.
 
virtual ZoomVideoSDKErrors startLiveStream (const ZoomVideoSDKLiveStreamParams &param)=0
 Starts a live stream for the current session using the specified parameters. See ZoomVideoSDKLiveStreamParams.
 
virtual ZoomVideoSDKErrors stopLiveStream ()=0
 Stop live stream.
 
virtual ZoomVideoSDKErrors canStartLiveStream ()=0
 Determin if can start the live stream.
 
virtual ZoomVideoSDKErrors getCurrentLiveStreamSetting (ZoomVideoSDKLiveStreamSetting &setting)=0
 Gets the current live stream settings.
 
virtual ZoomVideoSDKErrors updateLiveStreamSetting (const ZoomVideoSDKLiveStreamSetting &setting)=0
 Updates the live stream settings.
 
virtual bool canGetOrUpdateLiveStreamSetting ()=0
 Checks if the current user has permission to get or update live stream settings.
 

Detailed Description

Live stream helper interface.

Definition at line 16 of file zoom_video_sdk_livestream_helper_interface.h.

Member Function Documentation

◆ canGetOrUpdateLiveStreamSetting()

virtual bool IZoomVideoSDKLiveStreamHelper::canGetOrUpdateLiveStreamSetting ( )
pure virtual

Checks if the current user has permission to get or update live stream settings.

Returns
true if the user can get or update live stream settings; otherwise, the method failed.
Note
The live stream must be started, and only the user who started the live stream can modify the setting.

◆ canStartLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::canStartLiveStream ( )
pure virtual

Determin if can start the live stream.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed.

◆ getCurrentLiveStreamSetting()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::getCurrentLiveStreamSetting ( ZoomVideoSDKLiveStreamSetting & setting)
pure virtual

Gets the current live stream settings.

Parameters
settingThe parameter to store the current live stream settings
Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success If the operation succeeds; otherwise, the method failed.

◆ startLiveStream() [1/2]

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::startLiveStream ( const zchar_t * streamUrl,
const zchar_t * key,
const zchar_t * broadcastUrl )
pure virtual

Start live stream.

Parameters
streamUrlThe live stream url.
keyThe live stream key.
broadcastUrlThe live stream broadcast url.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed.
Deprecated
This method is deprecated. Use startLiveStream(const ZoomVideoSDKLiveStreamParams& param) instead.

◆ startLiveStream() [2/2]

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::startLiveStream ( const ZoomVideoSDKLiveStreamParams & param)
pure virtual

Starts a live stream for the current session using the specified parameters. See ZoomVideoSDKLiveStreamParams.

Parameters
paramThe live stream parameters containing stream URL, key, broadcast URL, and settings.
Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success If the operation succeeds; otherwise, the method failed.

◆ stopLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::stopLiveStream ( )
pure virtual

Stop live stream.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed.

◆ updateLiveStreamSetting()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveStreamHelper::updateLiveStreamSetting ( const ZoomVideoSDKLiveStreamSetting & setting)
pure virtual

Updates the live stream settings.

Parameters
settingThe new live stream settings to apply.
Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success If the operation succeeds; otherwise, the method failed.
Note
If the same settings as the previous call are passed, this function will return ZoomVideoSDKErrors_Wrong_Usage.