WZStreamConfig

Introduction

The WZStreamConfig class provides configuration properties for the streaming connection

Methods

-copyTo:

-initWithPreset:

-validateForBroadcast

copyTo:

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

Parameters

Discussion

Copy the reciever's settings to the given WZStreamConfig

initWithPreset:

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

Parameters

Return Value

An initialized WZStreamConfig instance

Discussion

Initializes a WZStreamConfig instance with a given WZFrameSizePreset

validateForBroadcast

- (nullable NSError *) validateForBroadcast; 

Return Value

nil if the minimum set of property values have been specified; otherwise, an NSError object describing the first encountered validation failure.

Discussion

Validates that the minimum set of property values have been specified necessary to initiate a live streaming 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) WZDataMap *connectionParameters; 

Discussion

The connection parameters passed as the query string at connect time

hostAddress

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

Discussion

The fully-qualified connection URL for this config

password

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

Discussion

The password for Source Authentication

portNumber

@property (nonatomic,
    assign) NSUInteger portNumber; 

Discussion

The server connection port number. Default is 1935

streamName

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

Discussion

The name of the live streaming stream

username

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

Discussion

The user name for Source Authentication