WZStreamConfig (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.configuration.WZMediaConfig
- - com.wowza.gocoder.sdk.api.configuration.WZStreamConfig

All Implemented Interfaces:

Serializable, Comparable<WZMediaConfig>

Direct Known Subclasses:

WowzaConfig, WZBroadcastConfig, WZPlayerConfig
```
public class WZStreamConfig
extends WZMediaConfig
implements Serializable
```
The WZStreamConfig class provides configuration properties for the streaming connection

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static 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 String`	`DEFAULT_STREAM` The default value for the target stream name (""myStream"")

Fields inherited from class com.wowza.gocoder.sdk.api.configuration.WZMediaConfig
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
`WZStreamConfig()` The default constructor
`WZStreamConfig(WZMediaConfig preset)` Construct a new instance using the property values from the specified preset configuration
`WZStreamConfig(WZStreamConfig other)` Construct a new instance using the property values from the specified instance

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getApplicationName()` Returns the name of the live streaming application
`WZDataMap`	`getConnectionParameters()`
`String`	`getConnectionURL()` Returns a fully qualified connection URL for this instance
`String`	`getHostAddress()` Returns the hostname or IP address of the streaming server
`int`	`getLogLevel()` Deprecated. Use `WZBroadcast.getLogLevel()` instead
`String`	`getPassword()` Returns the password for Source Authentication
`int`	`getPortNumber()` Returns the server connection port number
`WZDataMap`	`getStreamMetadata()`
`String`	`getStreamName()` Returns the target stream name
`String`	`getUsername()` Returns the username for Source Authentication
`void`	`set(WZMediaConfig preset)` Update the property values of this instance with the property values from the specified preset configuration
`void`	`set(WZStreamConfig other)` Update the property values of this instance with the property values from the specified instance
`void`	`setApplicationName(String applicationName)` Sets The name of the live streaming application
`void`	`setConnectionParameters(WZDataMap connectionParameters)` The elements in the specified data map will be added to the connection url as query string parameters and accessible to Wowza Streaming Engine server modules through the getQueryStr method of the IClient interface.
`void`	`setHostAddress(String address)` Set the hostname or IP address of the streaming server
`void`	`setLogLevel(int logLevel)` Deprecated. Use `WZBroadcast.setLogLevel(int)` instead
`void`	`setPassword(String password)` Sets the password for Source Authentication
`void`	`setPortNumber(int port)` Set the server connection port number
`void`	`setStreamMetadata(WZDataMap streamMetadata)` The key/value pairs in the specified data map will be added to the stream metadata and accessible to Wowza Streaming Engine server modules through the onMetadata method of the IMediaStreamActionNotify2 interface.
`void`	`setStreamName(String streamName)` Sets the target stream name
`void`	`setUsername(String username)` Sets the username for Source Authentication
`WZDataMap`	`toDataMap(WZDataMap dataMap)` Returns a `WZDataMap` containing the configuration properties
`String`	`toString()`
`WZStreamingError`	`validateForBroadcast()` Validates that the minimum set of property values have been specified necessary to initiate a live streaming broadcast
`WZStreamingError`	`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.WZMediaConfig
bitrateLabel, compareTo, equals, fromFrameSizes, getAudioBitRate, getAudioChannels, getAudioSampleRate, getFrameBufferSizeMultiplier, getFrameRateLowBandwidthSkipCount, getLabel, getLabel, getLowBandwidthScalingFactor, getPresetLabel, getPresetLabelByFrameSize, getVideoBitRate, getVideoFrameHeight, getVideoFramerate, getVideoFrameSize, getVideoFrameWidth, getVideoKeyFrameInterval, getVideoProfileLevel, getVideoRotation, isABREnabled, isAudioEnabled, isLandscape, isLandscapeRotation, isPortrait, isPortraitRotation, isValidScaleMode, isVideoEnabled, keyFrameIntervalFramesToSeconds, orientationLabel, orientationToRotation, orientationToSurfaceRotation, resetToDefaults, rotationToOrientation, setABREnabled, setAudioBitRate, setAudioChannels, setAudioEnabled, setAudioSampleRate, setFrameBufferSizeMultiplier, setFrameRateLowBandwidthSkipCount, setLowBandwidthScalingFactor, 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 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 String DEFAULT_STREAM
```
    The default value for the target stream name (""myStream"")
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WZStreamConfig
```
public WZStreamConfig()
```
    The default constructor
  - WZStreamConfig
```
public WZStreamConfig(WZStreamConfig other)
```
    Construct a new instance using the property values from the specified instance
    
    Parameters:
    
    other - The instance to replicate
  - WZStreamConfig
```
public WZStreamConfig(WZMediaConfig preset)
```
    Construct a new instance using the property values from the specified preset configuration
    
    Parameters:
    
    preset - The preset configuration to replicate
- Method Detail
  - set
```
public void set(WZStreamConfig other)
```
    Update the property values of this instance with the property values from the specified instance
    
    Parameters:
    
    other - The instance with the property values to replicate
  - set
```
public void set(WZMediaConfig preset)
```
    Update the property values of this instance with the property values from the specified preset configuration
    
    Overrides:
    
    set in class WZMediaConfig
    
    Parameters:
    
    preset - The preset configuration with the property values to replicate
  - getHostAddress
```
public String getHostAddress()
```
    Returns the hostname or IP address of the streaming server
    
    Returns:
    
    A hostname or IP address
  - setHostAddress
```
public void setHostAddress(String address)
```
    Set the hostname or IP address of the streaming server
    
    Parameters:
    
    address - A hostname or IP address
  - getPortNumber
```
public int getPortNumber()
```
    Returns the server connection port number
    
    Returns:
    
    A port number
  - setPortNumber
```
public void setPortNumber(int port)
```
    Set the server connection port number
    
    Parameters:
    
    port - A port number
  - getApplicationName
```
public String getApplicationName()
```
    Returns the name of the live streaming application
    
    Returns:
    
    The name of the live streaming application
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
    Sets The name of the live streaming application
    
    Parameters:
    
    applicationName - The name of the live streaming application
  - getStreamName
```
public String getStreamName()
```
    Returns the target stream name
    
    Returns:
    
    The stream name
  - setStreamName
```
public void setStreamName(String streamName)
```
    Sets the target stream name
    
    Parameters:
    
    streamName - Tshe stream name
  - getUsername
```
public String getUsername()
```
    Returns the username for Source Authentication
    
    Returns:
    
    The username
  - setUsername
```
public void setUsername(String username)
```
    Sets the username for Source Authentication
    
    Parameters:
    
    username - The username
  - getPassword
```
public String getPassword()
```
    Returns the password for Source Authentication
    
    Returns:
    
    The password
  - setPassword
```
public void setPassword(String password)
```
    Sets the password for Source Authentication
    
    Parameters:
    
    password - The password
  - setStreamMetadata
```
public void setStreamMetadata(WZDataMap streamMetadata)
```
    The key/value pairs in the specified data map will be added to the stream metadata and accessible to Wowza Streaming Engine server modules through the onMetadata method of the IMediaStreamActionNotify2 interface. Note that non-primitive elements of type WZDataType.DATA_LIST and WZDataType.DATA_MAP will be ignored.
    
    Parameters:
    
    streamMetadata - A map of key/value pairs defining the metadata.
  - getStreamMetadata
```
public WZDataMap getStreamMetadata()
```
    Returns:
    
    the current map of key/value pairs defining the metadata
  - setConnectionParameters
```
public void setConnectionParameters(WZDataMap connectionParameters)
```
    The elements in the specified data map will be added to the connection url as query string parameters and accessible to Wowza Streaming Engine server modules through the getQueryStr method of the IClient interface. Note that WZDataType.DATE values will be serialized as an Epoch-based long value representing the number of seconds that have elapsed since January 1, 1970 and non-primitive elements of type WZDataType.DATA_LIST and WZDataType.DATA_MAP will be ignored.
    
    Parameters:
    
    connectionParameters - A map of key/value pairs defining the connection url's query string parameters. Note that elements of type WZDataType.DATA_LIST and WZDataType.DATA_MAP will be ignored
  - getConnectionParameters
```
public WZDataMap getConnectionParameters()
```
    Returns:
    
    The current map of key/value pairs defining the connection url's query string parameters.
  - getConnectionURL
```
public String getConnectionURL()
```
    Returns 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 WZStreamingError validateForBroadcast()
```
    Validates that the minimum set of property values have been specified necessary to initiate a live streaming broadcast
    
    Returns:
    
    true> is validation succeeds, false> otherwise
  - validateForPlayback
```
public WZStreamingError validateForPlayback()
```
    Validates that the minimum set of property values have been specified necessary to play a stream
    
    Returns:
    
    true> is validation succeeds, false> otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class WZMediaConfig
  - toDataMap
```
public WZDataMap toDataMap(WZDataMap dataMap)
```
    Returns a WZDataMap containing the configuration properties
    
    Overrides:
    
    toDataMap in class WZMediaConfig
    
    Parameters:
    
    dataMap - a previouslly allocated data map in which to add the configuration properties
    
    Returns:
    
    the updated data map

Class WZStreamConfig

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

DEFAULT_APP

DEFAULT_STREAM

Constructor Detail

WZStreamConfig

WZStreamConfig

WZStreamConfig

Method Detail

set

set

getHostAddress

setHostAddress

getPortNumber

setPortNumber

getApplicationName

setApplicationName

getStreamName

setStreamName

getUsername

setUsername

getPassword

setPassword

setStreamMetadata

getStreamMetadata

setConnectionParameters

getConnectionParameters

getConnectionURL

getLogLevel

setLogLevel

validateForBroadcast

validateForPlayback

toString

toDataMap