com.wowza.gocoder.sdk.api.configuration

Class WOWZStreamConfig

java.lang.Object

com.wowza.gocoder.sdk.api.configuration.WOWZMediaConfig

com.wowza.gocoder.sdk.api.configuration.WOWZStreamConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WOWZMediaConfig>

Direct Known Subclasses:

WowzaConfig, WOWZBroadcastConfig, WOWZPlayerConfig

public class WOWZStreamConfig
extends WOWZMediaConfig
implements java.io.Serializable

The WOWZStreamConfig class provides configuration properties for the streaming connection.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_APP The default value for the name of the live streaming application ("live").
static int	DEFAULT_PORT The default value for the server connection port number (1935).
static java.lang.String	DEFAULT_STREAM The default value for the target stream name ("myStream").

Fields inherited from class com.wowza.gocoder.sdk.api.configuration.WOWZMediaConfig

ALWAYS_LANDSCAPE, ALWAYS_PORTRAIT, AUDIO_CHANNELS_MONO, AUDIO_CHANNELS_STEREO, CROP_TO_FRAME, DEFAULT_AUDIO_BITRATE, DEFAULT_AUDIO_SAMPLE_RATE, DEFAULT_SCALE_MODE, DEFAULT_VIDEO_BITRATE, DEFAULT_VIDEO_BITRATE_SCALING_FACTOR, DEFAULT_VIDEO_FRAME_BUFFER_MULTIPLIER, DEFAULT_VIDEO_FRAME_HEIGHT, DEFAULT_VIDEO_FRAME_RATE, DEFAULT_VIDEO_FRAME_SIZE, DEFAULT_VIDEO_FRAME_SKIP_COUNT, DEFAULT_VIDEO_FRAME_WIDTH, DEFAULT_VIDEO_KEYFRAME_INTERVAL, FILL_FRAME, FILL_VIEW, FRAME_SIZE_1280x720, FRAME_SIZE_1440x1080, FRAME_SIZE_176x144, FRAME_SIZE_1920x1080, FRAME_SIZE_320x240, FRAME_SIZE_352x288, FRAME_SIZE_3840x2160, FRAME_SIZE_640x480, FRAME_SIZE_960x540, ORIENTATION_LANDSCAPE, ORIENTATION_LANDSCAPE_INVERTED, ORIENTATION_PORTRAIT, ORIENTATION_PORTRAIT_INVERTED, PRESET_CONFIGS, RESIZE_TO_ASPECT, SAME_AS_SOURCE, SUPPORTED_AUDIO_SAMPLE_RATES

Constructor Summary

Constructors

Constructor and Description
WOWZStreamConfig() The default constructor.
WOWZStreamConfig(WOWZMediaConfig preset) Creates and initializes an instance using the property values from the specified preset configuration.
WOWZStreamConfig(WOWZStreamConfig other) Creates and initializes an instance using the property values from the specified instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationName() Gets the name of the live streaming application.
WOWZDataMap	getConnectionParameters()
java.lang.String	getConnectionURL() Gets a fully qualified connection URL for this instance.
java.lang.String	getHostAddress() Gets the host name or IP address of the streaming server.
int	getLogLevel() Deprecated. Use WZBroadcast#getLogLevel() instead.
java.lang.String	getPassword() Gets the password for source authentication.
int	getPortNumber() Gets the port number for the server connection.
WOWZDataMap	getStreamMetadata()
java.lang.String	getStreamName() Gets the target stream name.
java.lang.String	getUsername() Gets the user name for source authentication.
void	set(WOWZMediaConfig preset) Updates the property values of this instance with the property values from the specified preset configuration.
void	set(WOWZStreamConfig other) Updates the property values of this instance with the property values from the specified instance.
void	setApplicationName(java.lang.String applicationName) Sets the name of the live streaming application.
void	setConnectionParameters(WOWZDataMap connectionParameters) Adds the elements in the specified data map to the connection URL as query string parameters and makes them available to Wowza Streaming Engine server modules through the getQueryStr method of the IClient interface.
void	setHostAddress(java.lang.String address) Sets the host name or IP address of the streaming server.
void	setLogLevel(int logLevel) Deprecated. Use WZBroadcast#setLogLevel(int) instead.
void	setPassword(java.lang.String password) Sets the password for source authentication.
void	setPortNumber(int port) Sets the server connection port number.
void	setStreamMetadata(WOWZDataMap streamMetadata) Adds the key/value pairs in the specified data map to the stream metadata and makes them available to Wowza Streaming Engine server modules through the onMetadata method of the IMediaStreamActionNotify2 interface.
void	setStreamName(java.lang.String streamName) Sets the target stream name.
void	setUsername(java.lang.String username) Sets the user name for source authentication.
WOWZDataMap	toDataMap(WOWZDataMap dataMap) Gets a WOWZDataMap containing the configuration properties.
java.lang.String	toString()
WOWZStreamingError	validateForBroadcast() Validates that the minimum set of property values have been specified necessary to initiate a live streaming broadcast.
WOWZStreamingError	validateForPlayback() Validates that the minimum set of property values have been specified necessary to play a stream.

Methods inherited from class com.wowza.gocoder.sdk.api.configuration.WOWZMediaConfig

bitrateLabel, compareTo, equals, fromFrameSizes, getAudioBitRate, getAudioChannels, getAudioSampleRate, getFrameBufferSizeMultiplier, getFrameRateLowBandwidthSkipCount, getHLSBackupURL, getIsPlayback, getLabel, getLabel, getLowBandwidthScalingFactor, getPlayerExampleAutoconfig, getPresetLabel, getPresetLabelByFrameSize, getVideoBitRate, getVideoFrameHeight, getVideoFramerate, getVideoFrameSize, getVideoFrameWidth, getVideoKeyFrameInterval, getVideoProfileLevel, getVideoRotation, isABREnabled, isAudioEnabled, isHLSEnabled, isLandscape, isLandscapeRotation, isPortrait, isPortraitRotation, isValidScaleMode, isVideoEnabled, keyFrameIntervalFramesToSeconds, orientationLabel, orientationToRotation, orientationToSurfaceRotation, resetToDefaults, rotationToOrientation, setABREnabled, setAudioBitRate, setAudioChannels, setAudioEnabled, setAudioSampleRate, setFrameBufferSizeMultiplier, setFrameRateLowBandwidthSkipCount, setHLSBackupURL, setHLSEnabled, setIsPlayback, setLowBandwidthScalingFactor, setPlayerExampleAutoconfig, setVideoBitRate, setVideoEnabled, setVideoFrameHeight, setVideoFramerate, setVideoFrameSize, setVideoFrameSize, setVideoFrameWidth, setVideoKeyFrameInterval, setVideoProfileLevel, setVideoProfileLevel, setVideoRotation, surfaceRotationToOrientation, toDataMap, toFrameSizes

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

The default value for the server connection port number (1935).

See Also:

Constant Field Values

DEFAULT_APP

public static final java.lang.String DEFAULT_APP

The default value for the name of the live streaming application ("live").

See Also:

Constant Field Values

DEFAULT_STREAM

public static final java.lang.String DEFAULT_STREAM

The default value for the target stream name ("myStream").

See Also:

Constant Field Values

Constructor Detail

WOWZStreamConfig

public WOWZStreamConfig()

The default constructor.

WOWZStreamConfig

public WOWZStreamConfig(WOWZStreamConfig other)

Creates and initializes an instance using the property values from the specified instance.

Parameters:

other - The instance to use.

WOWZStreamConfig

public WOWZStreamConfig(WOWZMediaConfig preset)

Creates and initializes an instance using the property values from the specified preset configuration.

Parameters:

preset - The preset configuration to use.

Method Detail

set

public void set(WOWZStreamConfig other)

Updates the property values of this instance with the property values from the specified instance.

Parameters:

other - The instance with the property values to use.

set

public void set(WOWZMediaConfig preset)

Updates the property values of this instance with the property values from the specified preset configuration.

Overrides:

set in class WOWZMediaConfig

Parameters:

preset - The preset configuration with the property values to use.

getHostAddress

public java.lang.String getHostAddress()

Gets the host name or IP address of the streaming server.

Returns:

A host name or IP address.

setHostAddress

public void setHostAddress(java.lang.String address)

Sets the host name or IP address of the streaming server.

Parameters:

address - A host name or IP address.

getPortNumber

public int getPortNumber()

Gets the port number for the server connection.

Returns:

A port number.

setPortNumber

public void setPortNumber(int port)

Sets the server connection port number.

Parameters:

port - A port number.

getApplicationName

public java.lang.String getApplicationName()

Gets the name of the live streaming application.

Returns:

The name of the live streaming application.

setApplicationName

public void setApplicationName(java.lang.String applicationName)

Sets the name of the live streaming application.

Parameters:

applicationName - The name of the live streaming application.

getStreamName

public java.lang.String getStreamName()

Gets the target stream name.

Returns:

The stream name.

setStreamName

public void setStreamName(java.lang.String streamName)

Sets the target stream name.

Parameters:

streamName - The stream name.

getUsername

public java.lang.String getUsername()

Gets the user name for source authentication.

Returns:

The user name.

setUsername

public void setUsername(java.lang.String username)

Sets the user name for source authentication.

Parameters:

username - The user name.

getPassword

public java.lang.String getPassword()

Gets the password for source authentication.

Returns:

The password.

setPassword

public void setPassword(java.lang.String password)

Sets the password for source authentication.

Parameters:

password - The password.

setStreamMetadata

public void setStreamMetadata(WOWZDataMap streamMetadata)

Adds the key/value pairs in the specified data map to the stream metadata and makes them available to Wowza Streaming Engine server modules through the onMetadata method of the IMediaStreamActionNotify2 interface. Ignores non-primitive elements of type WOWZDataType#DATA_LIST and WOWZDataType#DATA_MAP.

Parameters:

streamMetadata - A map of key/value pairs defining the metadata.

getStreamMetadata

public WOWZDataMap getStreamMetadata()

Returns:

The current map of key/value pairs defining the metadata.

setConnectionParameters

public void setConnectionParameters(WOWZDataMap connectionParameters)

Adds the elements in the specified data map to the connection URL as query string parameters and makes them available to Wowza Streaming Engine server modules through the getQueryStr method of the IClient interface. WOWZDataType#DATE values will be serialized as an Epoch-based long value representing the number of seconds that have elapsed since January 1, 1970. Ignores non-primitive elements of type WOWZDataType#DATA_LIST and WOWZDataType#DATA_MAP.

Parameters:

connectionParameters - A map of key/value pairs defining the connection URL's query string parameters.

getConnectionParameters

public WOWZDataMap getConnectionParameters()

Returns:

The current map of key/value pairs defining the connection URL's query string parameters.

getConnectionURL

public java.lang.String getConnectionURL()

Gets a fully qualified connection URL for this instance.

Returns:

The connection URL.

getLogLevel

public int getLogLevel()

Deprecated. Use WZBroadcast#getLogLevel() instead.

setLogLevel

public void setLogLevel(int logLevel)

Deprecated. Use WZBroadcast#setLogLevel(int) instead.

validateForBroadcast

public WOWZStreamingError validateForBroadcast()

Validates that the minimum set of property values have been specified necessary to initiate a live streaming broadcast.

Returns:

True if validation succeeds; false otherwise.

validateForPlayback

public WOWZStreamingError validateForPlayback()

Validates that the minimum set of property values have been specified necessary to play a stream.

Returns:

True if validation succeeds; false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class WOWZMediaConfig

toDataMap

public WOWZDataMap toDataMap(WOWZDataMap dataMap)

Gets a WOWZDataMap containing the configuration properties.

Overrides:

toDataMap in class WOWZMediaConfig

Parameters:

dataMap - A previously allocated data map in which to add the configuration properties.

Returns:

The updated data map.