com.wowza.gocoder.sdk.api.broadcast

Class WZBroadcastConfig

java.lang.Object

com.wowza.gocoder.sdk.api.configuration.WZMediaConfig

com.wowza.gocoder.sdk.api.configuration.WZStreamConfig

com.wowza.gocoder.sdk.api.broadcast.WZBroadcastConfig

All Implemented Interfaces:

Serializable, Comparable<WZMediaConfig>

public class WZBroadcastConfig
extends WZStreamConfig

The WZBroadcastConfig class provides configuration properties for a live streaming broadcast

See Also:

Serialized Form

Field Summary

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

DEFAULT_APP, DEFAULT_PORT, DEFAULT_STREAM

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
WZBroadcastConfig() The default constructor
WZBroadcastConfig(WZBroadcastConfig other) Construct a new instance using the property values from the specified instance
WZBroadcastConfig(WZMediaConfig preset) Construct a new instance using the property values from the specified preset configuration

Method Summary

Modifier and Type	Method and Description
WZBroadcastAPI.AudioBroadcaster	getAudioBroadcaster() Return the audio broadcaster
WZSinkAPI.AudioSink[]	getAudioSinks() Return the broadcast audio sinks for Wowza Stream Engine or Wowza Streaming Cloud
WZBroadcastAPI.BroadcastErrorCallback	getErrorCallback() Return the broadcast error callback to be invoked when an error occurs during a broadcast
int	getOrientationBehavior() Returns value of the broadcast orientation settings that specifies the orientation in which video is streamed
com.wowza.gocoder.sdk.support.monitor.StreamingMonitor	getStreamingMonitor()
WZBroadcastAPI.VideoBroadcaster	getVideoBroadcaster() Return the video broadcaster.
WZSinkAPI.VideoSink[]	getVideoSinks() Return the broadcast video sinks for Wowza Stream Engine or Wowza Streaming Cloud
WZMediaConfig	getVideoSourceConfig() Returns configuration information for the video source
void	registerAudioSink(WZSinkAPI.AudioSink AudioSink)
void	registerVideoSink(WZSinkAPI.VideoSink videoSink)
void	set(WZBroadcastConfig other) Update the property values of this instance with the property values from the specified instance
void	set(WZMediaConfig preset) Update the property values of this instance with the property values from the specified preset configuration
void	setAudioBroadcaster(WZBroadcastAPI.AudioBroadcaster audioBroadcaster) Set the audio broadcaster
void	setOrientationBehavior(int broadcastOrientation) Sets the value of the broadcast orientation setting that specifies the orientation in which video is streamed
void	setVideoBroadcaster(WZBroadcastAPI.VideoBroadcaster videoBroadcaster) Set the video broadcaster
void	setVideoSourceConfig(WZMediaConfig videoSourceConfig) Specify configuration information for the video source
WZDataMap	toDataMap(WZDataMap dataMap) Returns a WZDataMap containing the configuration properties
String	toString()
void	unregisterAudioSink(WZSinkAPI.AudioSink AudioSink)
void	unregisterVideoSink(WZSinkAPI.VideoSink videoSink)
WZStreamingError	validateForBroadcast() Validates that all of the the required properties have been specified for a broadcast.

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

getApplicationName, getConnectionParameters, getConnectionURL, getHostAddress, getLogLevel, getPassword, getPortNumber, getStreamMetadata, getStreamName, getUsername, set, setApplicationName, setConnectionParameters, setHostAddress, setLogLevel, setPassword, setPortNumber, setStreamMetadata, setStreamName, setUsername, validateForPlayback

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

Constructor Detail

WZBroadcastConfig

public WZBroadcastConfig()

The default constructor

WZBroadcastConfig

public WZBroadcastConfig(WZBroadcastConfig other)

Construct a new instance using the property values from the specified instance

Parameters:

other - The instance to replicate

WZBroadcastConfig

public WZBroadcastConfig(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(WZBroadcastConfig 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 WZStreamConfig

Parameters:

preset - The preset configuration with the property values to replicate

getVideoBroadcaster

public WZBroadcastAPI.VideoBroadcaster getVideoBroadcaster()

Return the video broadcaster.

Returns:

The actively configured video broadcaster

setVideoBroadcaster

public void setVideoBroadcaster(WZBroadcastAPI.VideoBroadcaster videoBroadcaster)

Set the video broadcaster

Parameters:

videoBroadcaster - The newly configured video broadcaster

getAudioBroadcaster

public WZBroadcastAPI.AudioBroadcaster getAudioBroadcaster()

Return the audio broadcaster

Returns:

The actively configured audio broadcaster

setAudioBroadcaster

public void setAudioBroadcaster(WZBroadcastAPI.AudioBroadcaster audioBroadcaster)

Set the audio broadcaster

Parameters:

audioBroadcaster - The newly configured audio broadcaster

getVideoSinks

public WZSinkAPI.VideoSink[] getVideoSinks()

Return the broadcast video sinks for Wowza Stream Engine or Wowza Streaming Cloud

Returns:

The WSC/WSE video sinks

getAudioSinks

public WZSinkAPI.AudioSink[] getAudioSinks()

Return the broadcast audio sinks for Wowza Stream Engine or Wowza Streaming Cloud

Returns:

The WSC/WSE Audio sinks

getErrorCallback

public WZBroadcastAPI.BroadcastErrorCallback getErrorCallback()

Return the broadcast error callback to be invoked when an error occurs during a broadcast

Returns:

the broadcast error callback

getStreamingMonitor

public com.wowza.gocoder.sdk.support.monitor.StreamingMonitor getStreamingMonitor()

getVideoSourceConfig

public WZMediaConfig getVideoSourceConfig()

Returns configuration information for the video source

Returns:

the video source configuration

setVideoSourceConfig

public void setVideoSourceConfig(WZMediaConfig videoSourceConfig)

Specify configuration information for the video source

Parameters:

videoSourceConfig - the video source configuration

setOrientationBehavior

public void setOrientationBehavior(int broadcastOrientation)

Sets the value of the broadcast orientation setting that specifies the orientation in which video is streamed

Parameters:

broadcastOrientation - One of WZMediaConfig.SAME_AS_SOURCE (default), WZMediaConfig.ALWAYS_LANDSCAPE, WZMediaConfig.ALWAYS_PORTRAIT

getOrientationBehavior

public int getOrientationBehavior()

Returns value of the broadcast orientation settings that specifies the orientation in which video is streamed

Returns:

One of WZMediaConfig.SAME_AS_SOURCE (default), WZMediaConfig.ALWAYS_LANDSCAPE, WZMediaConfig.ALWAYS_PORTRAIT

validateForBroadcast

public WZStreamingError validateForBroadcast()

Validates that all of the the required properties have been specified for a broadcast.

Overrides:

validateForBroadcast in class WZStreamConfig

Returns:

<true if all of the required properties have been specified, false otherwise

registerVideoSink

public void registerVideoSink(WZSinkAPI.VideoSink videoSink)

unregisterVideoSink

public void unregisterVideoSink(WZSinkAPI.VideoSink videoSink)

registerAudioSink

public void registerAudioSink(WZSinkAPI.AudioSink AudioSink)

unregisterAudioSink

public void unregisterAudioSink(WZSinkAPI.AudioSink AudioSink)

toString

public String toString()

Overrides:

toString in class WZStreamConfig

toDataMap

public WZDataMap toDataMap(WZDataMap dataMap)

Returns a WZDataMap containing the configuration properties

Overrides:

toDataMap in class WZStreamConfig

Parameters:

dataMap - a previouslly allocated data map in which to add the configuration properties

Returns:

the updated data map