WOWZStreamConfig

Introduction

The WOWZStreamConfig class provides configuration properties for the streaming connection.

Methods

-copyTo:

-initWithPreset:

-validateForBroadcast

copyTo:

- (void) copyTo:(nonnull WOWZStreamConfig *)other; 

Parameters

Discussion

Copies the receiver's settings to the specified WOWZStreamConfig.

initWithPreset:

- (nonnull instancetype) initWithPreset:(WOWZFrameSizePreset)preset; 

Parameters

Return Value

An initialized WOWZStreamConfig instance.

Discussion

Initializes a WOWZStreamConfig instance with a specified WOWZFrameSizePreset.

validateForBroadcast

- (nullable NSError *) validateForBroadcast; 

Return Value

Nil if the minimum set of values has been specified; otherwise, an NSError object that describes the first validation failure.

Discussion

Validates that the minimum set of property values has been specified to initiate a live-stream broadcast.

Properties

applicationName

connectionParameters

hostAddress

password

portNumber

streamName

username

applicationName

@property (nonatomic,
    strong,
    nullable) NSString *applicationName; 

Discussion

The name of the live-streaming application.

connectionParameters

@property (nonatomic,
    strong,
    nullable) WOWZDataMap *connectionParameters; 

Discussion

The connection parameters passed as the query string at connection.

hostAddress

@property (nonatomic,
    strong,
    nullable) NSString *hostAddress; 

Discussion

The fully qualified connection URL for the config.

password

@property (nonatomic,
    strong,
    nullable) NSString *password; 

Discussion

The password for source authentication.

portNumber

@property (nonatomic,
    assign) NSUInteger portNumber; 

Discussion

The port number for the server connection. The default is 1935.

streamName

@property (nonatomic,
    strong,
    nullable) NSString *streamName; 

Discussion

The name of the live stream.

username

@property (nonatomic,
    strong,
    nullable) NSString *username; 

Discussion

The user name for source authentication.