WZBroadcast

Superclass:
NSObject
Declared In:

Introduction

The WZBroadcast class is used to configure and control a live streaming broadcast. Under normal circumstances, you do not need to access this class directly unless you are extending the GoCoder SDK.



Methods

-endBroadcast:
-startBroadcast:statusCallback:

endBroadcast:


- (nonnull WZStatus *) endBroadcast:(nullable id<WZStatusCallback>)statusCallback; 
Parameters
statusCallback

A callback that will be invoked with streaming session status updates and errors.

Return Value

A WZStatus object

Discussion

Stop the active live streaming broadcast


startBroadcast:statusCallback:


- (nonnull WZStatus *) startBroadcast:(nonnull WZStreamConfig *)config 
        statusCallback:(nullable id<WZStatusCallback>)statusCallback; 
Parameters
config

A WZStreamConfig describing the broadcast settings

statusCallback

A callback that will be invoked with streaming session status updates and errors.

Return Value

A WZStatus object

Discussion

Start a live streaming broadcast using the specified configuration


Properties

audioDevice
audioEncoder
status
statusCallback
videoEncoder

audioDevice


@property (nonatomic,
    strong,
    nullable) id<WZBroadcastComponent> audioDevice; 
Discussion

An object that adopts the WZBroadcastComponent protocol that will be used as the audio capture device for this broadcast session.


audioEncoder


@property (nonatomic,
    strong,
    nullable) id<WZBroadcastComponent> audioEncoder; 
Discussion

An object that adopts the WZBroadcastComponent protocol that will be used as the audio encoder for this broadcast session.


status


@property (nonatomic,
    readonly,
    nonnull) WZStatus *status; 
Discussion

The status of the broadcast


statusCallback


@property (nonatomic,
    unsafe_unretained,
    nullable) id<WZStatusCallback> statusCallback; 
Discussion

A callback that will be invoked with streaming session status updates and errors.


videoEncoder


@property (nonatomic,
    strong,
    nullable) id<WZBroadcastComponent> videoEncoder; 
Discussion

An object that adopts the WZBroadcastComponent protocol that will be used as the video encoder for this broadcast session.