Mac SDK
Instance Methods | Protected Attributes | Properties | List of all members
ZoomSDKLiveStreamHelper Class Reference
Inheritance diagram for ZoomSDKLiveStreamHelper:

Instance Methods

(ZoomSDKError) - canStartLiveStream
 Query if it is able for the user to enable live stream. More...
 
(NSArray *) - getSupportLiveStreamItem
 Get the items of live stream supported by the SDK. More...
 
(ZoomSDKError) - startLiveStream:
 Start a live stream. More...
 
(ZoomSDKError) - startLiveStreamByURL:StreamKey:BroadcastURL:
 Start a live stream with the URL customized by user. More...
 
(ZoomSDKError) - stopLiveStream
 Stop a live stream. More...
 
(LiveStreamStatus) - getLiveStreamStatus
 Get the status of current live stream. More...
 

Protected Attributes

id< ZoomSDKLiveStreamHelperDelegate_delegate
 

Properties

id< ZoomSDKLiveStreamHelperDelegatedelegate
 

Method Documentation

◆ canStartLiveStream

- (ZoomSDKError) canStartLiveStream

Query if it is able for the user to enable live stream.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ getLiveStreamStatus

- (LiveStreamStatus) getLiveStreamStatus

Get the status of current live stream.

Returns
If the function succeeds, it will return the LiveStreamStatus_InProgress, otherwise failed.

◆ getSupportLiveStreamItem

- (NSArray*) getSupportLiveStreamItem

Get the items of live stream supported by the SDK.

Returns
If the function succeeds, it will return the items, otherwise failed.

◆ startLiveStream:

- (ZoomSDKError) startLiveStream: (ZoomSDKLiveStreamItem *)  item

Start a live stream.

Parameters
itemThe item of live stream supported by the SDK.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

◆ startLiveStreamByURL:StreamKey:BroadcastURL:

- (ZoomSDKError) startLiveStreamByURL: (NSString *)  streamURL
StreamKey: (NSString *)  key
BroadcastURL: (NSString *)  broadcastURL 

Start a live stream with the URL customized by user.

Parameters
streamURLThe URL of customized live stream.
StreamKeyThe key of customized stream stream.
broadcastURLEveryone who uses this link can watch the live broadcast.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

◆ stopLiveStream

- (ZoomSDKError) stopLiveStream

Stop a live stream.

Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

The documentation for this class was generated from the following file: