com.wowza.gocoder.sdk.api.broadcast

Class WOWZBroadcastConfig

java.lang.Object

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

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

com.wowza.gocoder.sdk.api.broadcast.WOWZBroadcastConfig

All Implemented Interfaces:

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

public class WOWZBroadcastConfig
extends WOWZStreamConfig

The WOWZBroadcastConfig 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.WOWZStreamConfig

DEFAULT_APP, DEFAULT_PORT, DEFAULT_STREAM

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
WOWZBroadcastConfig() The default constructor.
WOWZBroadcastConfig(WOWZBroadcastConfig other) Creates and initializes an instance using the property values from the specified instance.
WOWZBroadcastConfig(WOWZMediaConfig preset) Creates and initializes an instance using the property values from the specified preset configuration.

Method Summary

Modifier and Type	Method and Description
WOWZBroadcastAPI.AudioBroadcaster	getAudioBroadcaster() Gets the audio broadcaster.
WOWZSinkAPI.AudioSink[]	getAudioSinks() Gets the broadcast audio sinks for Wowza Stream Engine or Wowza Streaming Cloud.
WOWZBroadcastAPI.BroadcastErrorCallback	getErrorCallback() Gets the broadcast error callback to be invoked when an error occurs during a broadcast.
int	getOrientationBehavior() Gets the broadcast orientation settings.
com.wowza.gocoder.sdk.support.monitor.StreamingMonitor	getStreamingMonitor()
WOWZBroadcastAPI.VideoBroadcaster	getVideoBroadcaster() Gets the video broadcaster.
WOWZSinkAPI.VideoSink[]	getVideoSinks() Gets the broadcast video sinks for Wowza Stream Engine or Wowza Streaming Cloud.
WOWZMediaConfig	getVideoSourceConfig() Gets configuration information for the video source.
void	registerAudioSink(WOWZSinkAPI.AudioSink AudioSink)
void	registerVideoSink(WOWZSinkAPI.VideoSink videoSink)
void	set(WOWZBroadcastConfig other) Updates the property values of this instance with the property values from the specified instance.
void	set(WOWZMediaConfig preset) Updates the property values of this instance with the property values from the specified preset configuration.
void	setAudioBroadcaster(WOWZBroadcastAPI.AudioBroadcaster audioBroadcaster) Sets the audio broadcaster.
void	setOrientationBehavior(int broadcastOrientation) Sets the orientation for the streaming broadcast.
void	setVideoBroadcaster(WOWZBroadcastAPI.VideoBroadcaster videoBroadcaster) Sets the video broadcaster.
void	setVideoSourceConfig(WOWZMediaConfig videoSourceConfig) Specifies configuration information for the video source.
WOWZDataMap	toDataMap(WOWZDataMap dataMap) Gets a WOWZDataMap that contains the configuration properties.
java.lang.String	toString()
void	unregisterAudioSink(WOWZSinkAPI.AudioSink AudioSink)
void	unregisterVideoSink(WOWZSinkAPI.VideoSink videoSink)
WOWZStreamingError	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.WOWZStreamConfig

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.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

Constructor Detail

WOWZBroadcastConfig

public WOWZBroadcastConfig()

The default constructor.

WOWZBroadcastConfig

public WOWZBroadcastConfig(WOWZBroadcastConfig other)

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

Parameters:

other - The instance to use.

WOWZBroadcastConfig

public WOWZBroadcastConfig(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(WOWZBroadcastConfig 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 WOWZStreamConfig

Parameters:

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

getVideoBroadcaster

public WOWZBroadcastAPI.VideoBroadcaster getVideoBroadcaster()

Gets the video broadcaster.

Returns:

The actively configured video broadcaster.

setVideoBroadcaster

public void setVideoBroadcaster(WOWZBroadcastAPI.VideoBroadcaster videoBroadcaster)

Sets the video broadcaster.

Parameters:

videoBroadcaster - The newly configured video broadcaster.

getAudioBroadcaster

public WOWZBroadcastAPI.AudioBroadcaster getAudioBroadcaster()

Gets the audio broadcaster.

Returns:

The actively configured audio broadcaster.

setAudioBroadcaster

public void setAudioBroadcaster(WOWZBroadcastAPI.AudioBroadcaster audioBroadcaster)

Sets the audio broadcaster.

Parameters:

audioBroadcaster - The newly configured audio broadcaster.

getVideoSinks

public WOWZSinkAPI.VideoSink[] getVideoSinks()

Gets the broadcast video sinks for Wowza Stream Engine or Wowza Streaming Cloud.

Returns:

The video sinks.

getAudioSinks

public WOWZSinkAPI.AudioSink[] getAudioSinks()

Gets the broadcast audio sinks for Wowza Stream Engine or Wowza Streaming Cloud.

Returns:

The audio sinks.

getErrorCallback

public WOWZBroadcastAPI.BroadcastErrorCallback getErrorCallback()

Gets 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 WOWZMediaConfig getVideoSourceConfig()

Gets configuration information for the video source.

Returns:

The video source configuration.

setVideoSourceConfig

public void setVideoSourceConfig(WOWZMediaConfig videoSourceConfig)

Specifies configuration information for the video source.

Parameters:

videoSourceConfig - The video source configuration.

setOrientationBehavior

public void setOrientationBehavior(int broadcastOrientation)

Sets the orientation for the streaming broadcast.

Parameters:

broadcastOrientation - WOWZMediaConfig.SAME_AS_SOURCE (default), WOWZMediaConfig.ALWAYS_LANDSCAPE, or WOWZMediaConfig.ALWAYS_PORTRAIT.

getOrientationBehavior

public int getOrientationBehavior()

Gets the broadcast orientation settings.

Returns:

WOWZMediaConfig.SAME_AS_SOURCE (default), WOWZMediaConfig.ALWAYS_LANDSCAPE, or WOWZMediaConfig.ALWAYS_PORTRAIT.

validateForBroadcast

public WOWZStreamingError validateForBroadcast()

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

Overrides:

validateForBroadcast in class WOWZStreamConfig

Returns:

True if all of the required properties have been specified; false otherwise.

registerVideoSink

public void registerVideoSink(WOWZSinkAPI.VideoSink videoSink)

unregisterVideoSink

public void unregisterVideoSink(WOWZSinkAPI.VideoSink videoSink)

registerAudioSink

public void registerAudioSink(WOWZSinkAPI.AudioSink AudioSink)

unregisterAudioSink

public void unregisterAudioSink(WOWZSinkAPI.AudioSink AudioSink)

toString

public java.lang.String toString()

Overrides:

toString in class WOWZStreamConfig

toDataMap

public WOWZDataMap toDataMap(WOWZDataMap dataMap)

Gets a WOWZDataMap that contains the configuration properties.

Overrides:

toDataMap in class WOWZStreamConfig

Parameters:

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

Returns:

The updated data map.