WowzaGoCoder

Introduction

The WowzaGoCoder class is the primary API interface for the GoCoder SDK. It provides methods for configuring and controlling devices and streaming live video.

Methods

-endStreaming:

+permissionForType:

-registerAudioEncoderSink:

-registerAudioSink:

-registerDataSink:eventName:

+registerLicenseKey:

-registerVideoEncoderSink:

-registerVideoSink:

+requestPermissionForType:response:

-sendDataEvent:eventName:params:callback:

-sendPingRequest:

+setLogLevel:

+setNetworkLogLevel:

+sharedInstance

-startStreaming:

-startStreamingWithConfig:config:

-startStreamingWithPreset:preset:

-unregisterAudioEncoderSink:

-unregisterAudioSink:

-unregisterDataSink:eventName:

-unregisterVideoEncoderSink:

-unregisterVideoSink:

-updateEncoderLimitedBitrate:

-updateEncoderTargetBitrate:

endStreaming:

- (void) endStreaming:(nullable id<WOWZStatusCallback>)statusCallback; 

Parameters

Discussion

Ends the active streaming session.

permissionForType:

+ (WowzaGoCoderCapturePermission) permissionForType:(WowzaGoCoderPermissionType)type; 

Parameters

Discussion

Gets the permission status for the specified WowzaGoCoderPermissionType.

registerAudioEncoderSink:

- (void) registerAudioEncoderSink:(nonnull id<WOWZAudioEncoderSink>)sink; 

Parameters

Discussion

Registers a WOWZAudioEncoderSink object with WowzaGoCoder. WOWZAudioEncoderSink protocol methods are called when audio is being captured and/or encoded.

registerAudioSink:

- (void) registerAudioSink:(nonnull id<WOWZAudioSink>)sink; 

Parameters

Discussion

Registers a WOWZAudioSink object with WowzaGoCoder. WOWZAudioSink protocol methods are called when audio is being captured and/or encoded.

registerDataSink:eventName:

- (void) registerDataSink:(nonnull id<WOWZDataSink>)sink 
        eventName:(nonnull NSString *)eventName; 

Parameters

Discussion

Registers a WOWZDataSink object with WowzaGoCoder. WOWZDataSink protocol methods are called when video is being encoded and a data event is received from the server.

registerLicenseKey:

+ (nullable NSError *) registerLicenseKey:(nonnull NSString *)licenseKey; 

Parameters

Return Value

Nil if no error, or an NSError that describes the license validation error.

Discussion

Registers and validates the GoCoder SDK license key.

registerVideoEncoderSink:

- (void) registerVideoEncoderSink:(nonnull id<WOWZVideoEncoderSink>)sink; 

Parameters

Discussion

Registers a WOWZVideoEncoderSink object with WowzaGoCoder. WOWZVideoEncoderSink protocol methods are called when video is actively encoding.

registerVideoSink:

- (void) registerVideoSink:(nonnull id<WOWZVideoSink>)sink; 

Parameters

Discussion

Registers a WOWZVideoSink object with WowzaGoCoder. WOWZVideoSink protocol methods are called when video is being encoded.

requestPermissionForType:response:

+ (void) requestPermissionForType:(WowzaGoCoderPermissionType)type 
        response:(nullable WOWZPermissionBlock)response; 

Parameters

Discussion

Requests explicit permission to use the device's camera or microphone.

sendDataEvent:eventName:params:callback:

- (void) sendDataEvent:(WOWZDataScope)scope eventName:(nonnull NSString *)eventName 
        params:(nonnull WOWZDataMap *)params callback:(nullable WOWZDataCallback)callback; 

Parameters

Discussion

Sends user-defined metadata with the current broadcast stream.

sendPingRequest:

- (void) sendPingRequest:(nonnull WOWZDataCallback)callback; 

Parameters

Discussion

Sends a ping request to the server and returns the result of the specified callback.

setLogLevel:

+ (void) setLogLevel:(WowzaGoCoderLogLevel)level; 

Parameters

Discussion

Sets the SDK log level.

setNetworkLogLevel:

+ (void) setNetworkLogLevel:(WowzaGoCoderNetworkLogLevel)level; 

Parameters

Discussion

Sets the SDK network layer log level.

sharedInstance

+ (nullable instancetype) sharedInstance; 

Return Value

An instance of the top-level GoCoder SDK API interface, or nil if licensing failed.

Discussion

Gets the WowzaGoCoder shared instance.

startStreaming:

- (void) startStreaming:(nullable id<WOWZStatusCallback>)statusCallback; 

Parameters

Discussion

Starts a live streaming session with a specified status callback.

startStreamingWithConfig:config:

- (void) startStreamingWithConfig:(nullable id<WOWZStatusCallback>)statusCallback 
        config:(nonnull WowzaConfig *)aConfig; 

Parameters

Discussion

Starts a live streaming session with a specified status callback and configuration settings.

startStreamingWithPreset:preset:

- (void) startStreamingWithPreset:(nullable id<WOWZStatusCallback>)statusCallback 
        preset:(WOWZFrameSizePreset)aPreset; 

Parameters

Discussion

Starts a live streaming session with a specified status callback and WOWZFrameSizePreset preset.

unregisterAudioEncoderSink:

- (void) unregisterAudioEncoderSink:(nonnull id<WOWZAudioEncoderSink>)sink; 

Parameters

Discussion

Unregisters a WOWZAudioEncoderSink object from WowzaGoCoder.

unregisterAudioSink:

- (void) unregisterAudioSink:(nonnull id<WOWZAudioSink>)sink; 

Parameters

Discussion

Unregisters a WOWZAudioSink object from WowzaGoCoder.

unregisterDataSink:eventName:

- (void) unregisterDataSink:(nonnull id<WOWZDataSink>)sink 
        eventName:(nonnull NSString *)eventName; 

Parameters

Discussion

Unregisters a WOWZDataSink object from WowzaGoCoder.

unregisterVideoEncoderSink:

- (void) unregisterVideoEncoderSink:(nonnull id<WOWZVideoEncoderSink>)sink; 

Parameters

Discussion

Unregisters a WOWZVideoEncoderSink object from WowzaGoCoder.

unregisterVideoSink:

- (void) unregisterVideoSink:(nonnull id<WOWZVideoSink>)sink; 

Parameters

Discussion

Unregisters a WOWZVideoSink object from WowzaGoCoder.

updateEncoderLimitedBitrate:

- (void) updateEncoderLimitedBitrate:(NSInteger)bitrate; 

Parameters

Discussion

Updates the broadcast to use a lower-bitrate encoding during limited network conditions.

updateEncoderTargetBitrate:

- (void) updateEncoderTargetBitrate:(NSInteger)bitrate; 

Parameters

Discussion

Updates the broadcast to use the target bitrate encoding during normal network conditions.

Typedefs

NS_ENUM

NS_ENUM

NS_ENUM

NS_ENUM

WowzaGoCoderCapturePermission

WowzaGoCoderLogLevel

WowzaGoCoderNetworkLogLevel

WowzaGoCoderPermissionType

WOWZPermissionBlock

NS_ENUM

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderLogLevel) { 
    WowzaGoCoderLogLevelOff, WowzaGoCoderLogLevelDefault, WowzaGoCoderLogLevelVerbose 
}; 

Constants

Discussion

Settings for the log level for the GoCoder SDK.

See Also

NS_ENUM

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderNetworkLogLevel) { 
    WowzaGoCoderNetworkLogLevelVerbose = 1, WowzaGoCoderNetworkLogLevelDebug = 
    2, WowzaGoCoderNetworkLogLevelInfo = 3, WowzaGoCoderNetworkLogLevelWarn = 
    4, WowzaGoCoderNetworkLogLevelError = 5 
}; 

Constants

Discussion

Settings for the network log level for the GoCoder SDK.

See Also

NS_ENUM

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderCapturePermission) { 
    WowzaGoCoderCapturePermissionAuthorized, WowzaGoCoderCapturePermissionDenied, 
    WowzaGoCoderCapturePermissionNotDetermined 
}; 

Constants

Discussion

Permissions for either an audio- or video-capture device.

See Also

NS_ENUM

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderPermissionType) { 
    WowzaGoCoderPermissionTypeCamera, WowzaGoCoderPermissionTypeMicrophone 
}; 

Constants

Discussion

The permission types that are available in the SDK.

See Also

WowzaGoCoderCapturePermission

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderCapturePermission) { 
    WowzaGoCoderCapturePermissionAuthorized, WowzaGoCoderCapturePermissionDenied, 
    WowzaGoCoderCapturePermissionNotDetermined 
}; 

Constants

Discussion

Permissions for either an audio- or video-capture device.

See Also

WowzaGoCoderLogLevel

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderLogLevel) { 
    WowzaGoCoderLogLevelOff, WowzaGoCoderLogLevelDefault, WowzaGoCoderLogLevelVerbose 
}; 

Constants

Discussion

Settings for the log level for the GoCoder SDK.

See Also

WowzaGoCoderNetworkLogLevel

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderNetworkLogLevel) { 
    WowzaGoCoderNetworkLogLevelVerbose = 1, WowzaGoCoderNetworkLogLevelDebug = 
    2, WowzaGoCoderNetworkLogLevelInfo = 3, WowzaGoCoderNetworkLogLevelWarn = 
    4, WowzaGoCoderNetworkLogLevelError = 5 
}; 

Constants

Discussion

Settings for the network log level for the GoCoder SDK.

See Also

WowzaGoCoderPermissionType

private

typedef NS_ENUM(NSUInteger, WowzaGoCoderPermissionType) { 
    WowzaGoCoderPermissionTypeCamera, WowzaGoCoderPermissionTypeMicrophone 
}; 

Constants

Discussion

The permission types that are available in the SDK.

See Also

WOWZPermissionBlock

private

typedef void (^WOWZPermissionBlock)(
    WowzaGoCoderCapturePermission permission); 

Discussion

A callback block that's used with requestCameraPermission and requestMicrophonePermission.

Properties

audioMuted

audioSessionOptions

cameraPreview

cameraView

config

isStreaming

metaData

status

audioMuted

@property (nonatomic,
    assign,
    getter=isAudioMuted) BOOL audioMuted; 

Discussion

The muted state of the audio encoder.

audioSessionOptions

@property (nonatomic,
    assign) AVAudioSessionCategoryOptions audioSessionOptions; 

Discussion

The AVAudioSessionCategoryOptions to use when streaming with audio. The default is AVAudioSessionCategoryOptionAllowBluetooth. This property must be set before starting a preview session.

cameraPreview

@property (nonatomic,
    nullable,
    readonly) WOWZCameraPreview *cameraPreview; 

Discussion

The WOWZCameraPreview object created when the cameraView is set.

cameraView

@property (nonatomic,
    nullable) UIView *cameraView; 

Discussion

The view to use for the camera preview.

config

@property (nonatomic,
    nonnull,
    copy) WowzaConfig *config; 

Discussion

The audio, video, and stream configuration settings.

isStreaming

@property (nonatomic,
    readonly) BOOL isStreaming; 

Discussion

True if a live stream is broadcasting; false otherwise.

metaData

@property (nonatomic,
    readonly,
    nullable) WOWZDataMap *metaData; 

Discussion

The stream metadata for the broadcasted stream.

status

@property (nonatomic,
    nonnull,
    readonly) WOWZStatus *status; 

Discussion

The status of the current live streaming session.