WOWZMediaConfig (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.configuration.WOWZMediaConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

WOWZStreamConfig
```
public class WOWZMediaConfig
extends java.lang.Object
implements java.lang.Comparable<WOWZMediaConfig>, java.io.Serializable
```
The WOWZMediaConfig class provides configuration properties for video and audio capture and encoding.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALWAYS_LANDSCAPE` An identifier for specifying that video should always be sent in landscape orientation.
`static int`	`ALWAYS_PORTRAIT` An identifier for specifying that video should always be sent in portrait orientation.
`static int`	`AUDIO_CHANNELS_MONO` An identifier for specifying single-channel (mono) audio.
`static int`	`AUDIO_CHANNELS_STEREO` An identifier for specifying dual-channel (stereo) audio.
`static int`	`CROP_TO_FRAME` Deprecated.
`static int`	`DEFAULT_AUDIO_BITRATE` The default value for the audio bitrate (64000 bps).
`static int`	`DEFAULT_AUDIO_SAMPLE_RATE` The default value for the audio sample rate (44100 Hz).
`static int`	`DEFAULT_SCALE_MODE` The default value for the video display scale mode (2).
`static int`	`DEFAULT_VIDEO_BITRATE` The default value for the video bitrate (1500 bps).
`static float`	`DEFAULT_VIDEO_BITRATE_SCALING_FACTOR`
`static int`	`DEFAULT_VIDEO_FRAME_BUFFER_MULTIPLIER`
`static int`	`DEFAULT_VIDEO_FRAME_HEIGHT` The default value for the height of the video frame (480 pixels).
`static int`	`DEFAULT_VIDEO_FRAME_RATE` The default value for the video frame rate (30 fps).
`static WOWZSize`	`DEFAULT_VIDEO_FRAME_SIZE` The default value for the video frame size, in pixels.
`static int`	`DEFAULT_VIDEO_FRAME_SKIP_COUNT`
`static int`	`DEFAULT_VIDEO_FRAME_WIDTH` The default value for the width of the video frame (640 pixels).
`static int`	`DEFAULT_VIDEO_KEYFRAME_INTERVAL` The default value for the keyframe interval (30 frames).
`static int`	`FILL_FRAME` Deprecated.
`static int`	`FILL_VIEW` An identifier that specifies video and image previews should be resized and cropped, if necessary, to preserve the aspect ratio and fill the entire view.
`static WOWZMediaConfig`	`FRAME_SIZE_1280x720` An identifier for a preset configuration representing 720p HD video: a video resolution of 1280x720 pixels, a 3.75-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_1440x1080` An identifier for a preset configuration representing 1080i video: a video resolution of 1440x1080 pixels, a 5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_176x144` An identifier for a preset configuration appropriate for Quarter CIF (QCIF): a video resolution of 176x144 pixels, a 280-kbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_1920x1080` An identifier for a preset configuration representing 1080p HD video: a video resolution of 1920x1080 pixels, a 5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_320x240` An identifier for a preset configuration appropriate for Quarter Video Graphics Array (QVGA): a video resolution of 320x240 pixels, a 280-kbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_352x288` An identifier for a preset configuration appropriate for Common Intermediate Format (CIF): a video resolution of 352x288 pixels, a 1-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_3840x2160` An identifier for a preset configuration representing 4K Ultra HD video: a video resolution of 3840x2160 pixels, an 8-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_640x480` An identifier for a preset configuration appropriate for VGA displays: a video resolution of 640x480 pixels, a 1.5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static WOWZMediaConfig`	`FRAME_SIZE_960x540` An identifier for a preset configuration appropriate for high-bandwidth connections: a video resolution of 960x540 pixels, a 1.5-Bbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
`static int`	`ORIENTATION_LANDSCAPE` An identifier for specifying landscape orientation.
`static int`	`ORIENTATION_LANDSCAPE_INVERTED` An identifier for specifying inverted (upside down) landscape orientation.
`static int`	`ORIENTATION_PORTRAIT` An identifier for specifying portrait orientation.
`static int`	`ORIENTATION_PORTRAIT_INVERTED` An identifier for specifying inverted (upside down) portrait orientation.
`static WOWZMediaConfig[]`	`PRESET_CONFIGS` An array containing the preset configuration identifiers, sorted from lowest to highest frame size.
`static int`	`RESIZE_TO_ASPECT` An identifier that specifies video and image previews should be resized and letterboxed, if necessary, to preserve the aspect ratio.
`static int`	`SAME_AS_SOURCE` An identifier for specifying that video should be sent in the same orientation as the video input device or source when streaming began.
`static int[]`	`SUPPORTED_AUDIO_SAMPLE_RATES` The supported audio sample rates.

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`bitrateLabel(int bps)` Gets a human-readable representation of a bitrate value, for example, "800bps" or "1.5kbps."
`int`	`compareTo(WOWZMediaConfig other)` Compares the frame size of this instance with another instance.
`boolean`	`equals(java.lang.Object other)` Compares this instance with another to see if they use the same video frame size.
`static WOWZMediaConfig[]`	`fromFrameSizes(WOWZSize[] frameSizes)` Gets an array of media configurations from an array of video frame sizes.
`int`	`getAudioBitRate()` Gets the audio bitrate.
`int`	`getAudioChannels()` Gets the number of audio channels.
`int`	`getAudioSampleRate()` Gets the audio sample rate.
`int`	`getFrameBufferSizeMultiplier()`
`int`	`getFrameRateLowBandwidthSkipCount()`
`java.lang.String`	`getHLSBackupURL()` Gets the HLS playback URL.
`java.lang.Boolean`	`getIsPlayback()` Checks whether the config is used for playback.
`java.lang.String`	`getLabel(boolean withFrameSize, boolean withPreset, boolean withBitrate)` Deprecated.
`java.lang.String`	`getLabel(boolean withFrameSize, boolean withPreset, boolean withAspect, boolean withBitrate)` Gets a configurable, human-readable representation of this configuration instance.
`float`	`getLowBandwidthScalingFactor()`
`java.lang.String`	`getPlayerExampleAutoconfig()`
`java.lang.String`	`getPresetLabel()` Gets the label for a preset configuration, for example, "1080p."
`java.lang.String`	`getPresetLabelByFrameSize()` Gets the label for a preset configuration, for example "1080p," that matches this instance's video frame size.
`int`	`getVideoBitRate()` Gets the video bitrate.
`int`	`getVideoFrameHeight()` Gets the video frame height.
`int`	`getVideoFramerate()` Gets the video frame rate.
`WOWZSize`	`getVideoFrameSize()` Gets the video frame size.
`int`	`getVideoFrameWidth()` Gets the video frame width.
`int`	`getVideoKeyFrameInterval()` Gets the keyframe interval, which is the number of frames between keyframes.
`WOWZProfileLevel`	`getVideoProfileLevel()` Gets the H.264 profile level.
`int`	`getVideoRotation()` Gets the rotation angle of the video source, with 0 being the natural landscape orientation and 90 being the natural portrait orientation.
`boolean`	`isABREnabled()` Checks whether adaptive bitrate (ABR) streaming is enabled.
`boolean`	`isAudioEnabled()` Checks whether audio streaming is enabled.
`boolean`	`isHLSEnabled()` Checks whether HLS playback is enabled.
`static boolean`	`isLandscape(int orientation)` Checks whether the specified orientation identifier matches one of the landscape identifiers.
`static boolean`	`isLandscapeRotation(int rotation)` Checks whether the rotation angle specifies landscape orientation.
`static boolean`	`isPortrait(int orientation)` Checks whether the specified orientation identifier matches one of the portrait identifiers.
`static boolean`	`isPortraitRotation(int rotation)` Checks whether the rotation angle specifies portrait orientation.
`static boolean`	`isValidScaleMode(int scaleMode)` Checks whether the specified value is a valid scale mode property value.
`boolean`	`isVideoEnabled()` Checks whether video streaming is enabled.
`static int`	`keyFrameIntervalFramesToSeconds(int frames, int frameRate)` Converts between a number of frames to frames per second (fps), based on a specfied frame rate.
`static java.lang.String`	`orientationLabel(int orientation)` Gets a string representation of the specified orientation.
`static int`	`orientationToRotation(int orientation)` Converts an orientation specifier to a surface rotation angle.
`static int`	`orientationToSurfaceRotation(int orientation)` Deprecated. Use `orientationToRotation(int)` instead.
`void`	`resetToDefaults()`
`static int`	`rotationToOrientation(int rotation)` Converts a surface rotation angle to an orientation identifier.
`void`	`set(WOWZMediaConfig other)` Updates the property values of this instance with the property values from the specified instance.
`void`	`setABREnabled(boolean abrEnabled)` Enables adaptive bitrate (ABR) streaming.
`void`	`setAudioBitRate(int audioBitRate)` Sets the audio bitrate.
`void`	`setAudioChannels(int audioChannels)` Sets the number of audio channels.
`void`	`setAudioEnabled(boolean audioEnabled)` Enables audio streaming.
`int`	`setAudioSampleRate(int audioSampleRate)` Sets the the audio sample rate.
`void`	`setFrameBufferSizeMultiplier(int frameBufferSizeMultiplier)` The value by which to multiply the video frame rate to determine the number of frames to buffer before the encoder starts to throttle bitrate and/or frame rate.
`void`	`setFrameRateLowBandwidthSkipCount(int frameRateLowBandwidthSkipCount)` The number of frames to skip when the encoder can't keep up with the broadcaster.
`void`	`setHLSBackupURL(java.lang.String backupURL)` Specifies an Apple HLS URL to use for playback.
`void`	`setHLSEnabled(boolean useHLS)` Specifies primary playback over Apple HLS.
`void`	`setIsPlayback(boolean isPlayback)` Specifies whether the config is used for playback.
`void`	`setLowBandwidthScalingFactor(float lowBandwidthScalingFactor)` The factor by which to scale the bitrate in low-bandwidth conditions.
`void`	`setPlayerExampleAutoconfig(java.lang.String configName)`
`void`	`setVideoBitRate(int videoBitRate)` Sets the video bitrate.
`void`	`setVideoEnabled(boolean videoEnabled)` Enables video streaming.
`void`	`setVideoFrameHeight(int height)` Sets the video frame height; should be less than the frame width.
`void`	`setVideoFramerate(int videoFrameRate)` Sets the video frame rate.
`void`	`setVideoFrameSize(int width, int height)` Sets the video frame size using the specified values.
`void`	`setVideoFrameSize(WOWZSize videoSize)` Sets the video frame size using the values from the specified instance.
`void`	`setVideoFrameWidth(int width)` Sets the video frame width; should be greater than the frame height.
`void`	`setVideoKeyFrameInterval(int videoKeyFrameInterval)` Sets the keyframe interval, which is the number of frames between keyframes.
`void`	`setVideoProfileLevel(int profile, int level)` Sets the H.264 profile.
`void`	`setVideoProfileLevel(WOWZProfileLevel profileLevel)` Sets the H.264 profile.
`void`	`setVideoRotation(int videoRotation)` Sets the rotation angle of the video source, with 0 being the natural landscape orientation and 90 being the natural portrait orientation.
`static int`	`surfaceRotationToOrientation(int rotation)` Deprecated. Use `rotationToOrientation(int)` instead.
`WOWZDataMap`	`toDataMap()` Gets a WOWZDataMap that contains the configuration properties.
`WOWZDataMap`	`toDataMap(WOWZDataMap dataMap)` Gets a WOWZDataMap that contains the configuration properties.
`static WOWZSize[]`	`toFrameSizes(WOWZMediaConfig[] mediaConfigs)` Gets an array of the video frame sizes contained in an array of media configuration instances.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_VIDEO_FRAME_WIDTH
```
public static final int DEFAULT_VIDEO_FRAME_WIDTH
```
    The default value for the width of the video frame (640 pixels).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_HEIGHT
```
public static final int DEFAULT_VIDEO_FRAME_HEIGHT
```
    The default value for the height of the video frame (480 pixels).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_SIZE
```
public static final WOWZSize DEFAULT_VIDEO_FRAME_SIZE
```
    The default value for the video frame size, in pixels.
  - DEFAULT_VIDEO_BITRATE
```
public static final int DEFAULT_VIDEO_BITRATE
```
    The default value for the video bitrate (1500 bps).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_RATE
```
public static final int DEFAULT_VIDEO_FRAME_RATE
```
    The default value for the video frame rate (30 fps).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_KEYFRAME_INTERVAL
```
public static final int DEFAULT_VIDEO_KEYFRAME_INTERVAL
```
    The default value for the keyframe interval (30 frames).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AUDIO_SAMPLE_RATE
```
public static final int DEFAULT_AUDIO_SAMPLE_RATE
```
    The default value for the audio sample rate (44100 Hz).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AUDIO_BITRATE
```
public static final int DEFAULT_AUDIO_BITRATE
```
    The default value for the audio bitrate (64000 bps).
    
    See Also:
    
    Constant Field Values
  - SUPPORTED_AUDIO_SAMPLE_RATES
```
public static final int[] SUPPORTED_AUDIO_SAMPLE_RATES
```
    The supported audio sample rates.
  - RESIZE_TO_ASPECT
```
public static final int RESIZE_TO_ASPECT
```
    An identifier that specifies video and image previews should be resized and letterboxed, if necessary, to preserve the aspect ratio.
    
    See Also:
    
    Constant Field Values
  - CROP_TO_FRAME
```
public static final int CROP_TO_FRAME
```
    Deprecated.
    
    An alias for RESIZE_TO_ASPECT.
    
    See Also:
    
    Constant Field Values
  - FILL_VIEW
```
public static final int FILL_VIEW
```
    An identifier that specifies video and image previews should be resized and cropped, if necessary, to preserve the aspect ratio and fill the entire view.
    
    See Also:
    
    Constant Field Values
  - FILL_FRAME
```
public static final int FILL_FRAME
```
    Deprecated.
    
    An alias for FILL_VIEW.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCALE_MODE
```
public static final int DEFAULT_SCALE_MODE
```
    The default value for the video display scale mode (2).
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_LANDSCAPE
```
public static final int ORIENTATION_LANDSCAPE
```
    An identifier for specifying landscape orientation.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_PORTRAIT
```
public static final int ORIENTATION_PORTRAIT
```
    An identifier for specifying portrait orientation.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_LANDSCAPE_INVERTED
```
public static final int ORIENTATION_LANDSCAPE_INVERTED
```
    An identifier for specifying inverted (upside down) landscape orientation.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_PORTRAIT_INVERTED
```
public static final int ORIENTATION_PORTRAIT_INVERTED
```
    An identifier for specifying inverted (upside down) portrait orientation.
    
    See Also:
    
    Constant Field Values
  - ALWAYS_LANDSCAPE
```
public static final int ALWAYS_LANDSCAPE
```
    An identifier for specifying that video should always be sent in landscape orientation. Video that's captured while the video input device or source is in portrait orientation will be letterboxed.
    
    See Also:
    
    Constant Field Values
  - ALWAYS_PORTRAIT
```
public static final int ALWAYS_PORTRAIT
```
    An identifier for specifying that video should always be sent in portrait orientation. Video that is captured while the video input device or source is in landscape orientation will be letterboxed.
    
    See Also:
    
    Constant Field Values
  - SAME_AS_SOURCE
```
public static final int SAME_AS_SOURCE
```
    An identifier for specifying that video should be sent in the same orientation as the video input device or source when streaming began.
    
    See Also:
    
    Constant Field Values
  - AUDIO_CHANNELS_STEREO
```
public static final int AUDIO_CHANNELS_STEREO
```
    An identifier for specifying dual-channel (stereo) audio.
    
    See Also:
    
    Constant Field Values
  - AUDIO_CHANNELS_MONO
```
public static final int AUDIO_CHANNELS_MONO
```
    An identifier for specifying single-channel (mono) audio.
    
    See Also:
    
    Constant Field Values
  - FRAME_SIZE_176x144
```
public static final WOWZMediaConfig FRAME_SIZE_176x144
```
    An identifier for a preset configuration appropriate for Quarter CIF (QCIF): a video resolution of 176x144 pixels, a 280-kbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_320x240
```
public static final WOWZMediaConfig FRAME_SIZE_320x240
```
    An identifier for a preset configuration appropriate for Quarter Video Graphics Array (QVGA): a video resolution of 320x240 pixels, a 280-kbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_352x288
```
public static final WOWZMediaConfig FRAME_SIZE_352x288
```
    An identifier for a preset configuration appropriate for Common Intermediate Format (CIF): a video resolution of 352x288 pixels, a 1-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_640x480
```
public static final WOWZMediaConfig FRAME_SIZE_640x480
```
    An identifier for a preset configuration appropriate for VGA displays: a video resolution of 640x480 pixels, a 1.5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_960x540
```
public static final WOWZMediaConfig FRAME_SIZE_960x540
```
    An identifier for a preset configuration appropriate for high-bandwidth connections: a video resolution of 960x540 pixels, a 1.5-Bbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_1280x720
```
public static final WOWZMediaConfig FRAME_SIZE_1280x720
```
    An identifier for a preset configuration representing 720p HD video: a video resolution of 1280x720 pixels, a 3.75-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_1440x1080
```
public static final WOWZMediaConfig FRAME_SIZE_1440x1080
```
    An identifier for a preset configuration representing 1080i video: a video resolution of 1440x1080 pixels, a 5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_1920x1080
```
public static final WOWZMediaConfig FRAME_SIZE_1920x1080
```
    An identifier for a preset configuration representing 1080p HD video: a video resolution of 1920x1080 pixels, a 5-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - FRAME_SIZE_3840x2160
```
public static final WOWZMediaConfig FRAME_SIZE_3840x2160
```
    An identifier for a preset configuration representing 4K Ultra HD video: a video resolution of 3840x2160 pixels, an 8-Mbps video bitrate, 30 fps, a keyframe interval of 30, a 44.1 kHz audio sample rate, and a 64-kbps audio bitrate.
  - PRESET_CONFIGS
```
public static final WOWZMediaConfig[] PRESET_CONFIGS
```
    An array containing the preset configuration identifiers, sorted from lowest to highest frame size.
  - DEFAULT_VIDEO_BITRATE_SCALING_FACTOR
```
public static final float DEFAULT_VIDEO_BITRATE_SCALING_FACTOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_BUFFER_MULTIPLIER
```
public static final int DEFAULT_VIDEO_FRAME_BUFFER_MULTIPLIER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_SKIP_COUNT
```
public static final int DEFAULT_VIDEO_FRAME_SKIP_COUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WOWZMediaConfig
```
public WOWZMediaConfig()
```
    The default constructor.
  - WOWZMediaConfig
```
public WOWZMediaConfig(WOWZMediaConfig other)
```
    Creates and initializes an instance using the property values from the specified instance.
    
    Parameters:
    
    other - The instance to use.
- Method Detail
  - isValidScaleMode
```
public static boolean isValidScaleMode(int scaleMode)
```
    Checks whether the specified value is a valid scale mode property value.
    
    Parameters:
    
    scaleMode - A scale mode property value.
    
    Returns:
    
    True if the value is valid; false otherwise.
  - isLandscape
```
public static boolean isLandscape(int orientation)
```
    Checks whether the specified orientation identifier matches one of the landscape identifiers.
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED.
    
    Returns:
    
    True if the specified identifier is one of the landscape identifiers; false otherwise.
  - isLandscapeRotation
```
public static boolean isLandscapeRotation(int rotation)
```
    Checks whether the rotation angle specifies landscape orientation.
    
    Parameters:
    
    rotation - The rotation angle, in degrees.
    
    Returns:
    
    True if the rotation angle specifies landscape orientation; false otherwise.
  - orientationLabel
```
public static java.lang.String orientationLabel(int orientation)
```
    Gets a string representation of the specified orientation.
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED.
    
    Returns:
    
    The orientation, either portrait or landscape.
  - isPortrait
```
public static boolean isPortrait(int orientation)
```
    Checks whether the specified orientation identifier matches one of the portrait identifiers.
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED.
    
    Returns:
    
    True if the identifier is one of the portrait identifiers; false otherwise.
  - isPortraitRotation
```
public static boolean isPortraitRotation(int rotation)
```
    Checks whether the rotation angle specifies portrait orientation.
    
    Parameters:
    
    rotation - The rotation angle, in degrees.
    
    Returns:
    
    True if the rotation angle specifies portrait orientation; false otherwise.
  - rotationToOrientation
```
public static int rotationToOrientation(int rotation)
```
    Converts a surface rotation angle to an orientation identifier. ORIENTATION_LANDSCAPE represents 0 degrees and is followed clockwise at 90-degree increments by ORIENTATION_PORTRAIT (90 degrees), ORIENTATION_LANDSCAPE_INVERTED (180 degrees), and ORIENTATION_PORTRAIT_INVERTED (270 degrees).
    
    Parameters:
    
    rotation - A surface rotation angle, in degrees.
    
    Returns:
    
    An orientation identifier: ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED.
  - surfaceRotationToOrientation
```
public static int surfaceRotationToOrientation(int rotation)
```
    Deprecated. Use rotationToOrientation(int) instead.
  - orientationToRotation
```
public static int orientationToRotation(int orientation)
```
    Converts an orientation specifier to a surface rotation angle.
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE (0 degrees), ORIENTATION_PORTRAIT (90 degrees), ORIENTATION_LANDSCAPE_INVERTED (180 degrees), or ORIENTATION_PORTRAIT_INVERTED (270 degrees).
    
    Returns:
    
    The rotation angle, in degrees.
  - orientationToSurfaceRotation
```
public static int orientationToSurfaceRotation(int orientation)
```
    Deprecated. Use orientationToRotation(int) instead.
  - keyFrameIntervalFramesToSeconds
```
public static int keyFrameIntervalFramesToSeconds(int frames,
                                                  int frameRate)
```
    Converts between a number of frames to frames per second (fps), based on a specfied frame rate.
    
    Parameters:
    
    frames - The number of frames between keyframes.
    
    frameRate - The frame rate.
    
    Returns:
    
    The number of seconds between keyframes.
  - bitrateLabel
```
public static java.lang.String bitrateLabel(int bps)
```
    Gets a human-readable representation of a bitrate value, for example, "800bps" or "1.5kbps."
    
    Parameters:
    
    bps - A bitrate value.
    
    Returns:
    
    A string representation of the bitrate with a unit suffix appended.
  - toFrameSizes
```
public static WOWZSize[] toFrameSizes(WOWZMediaConfig[] mediaConfigs)
```
    Gets an array of the video frame sizes contained in an array of media configuration instances.
    
    Parameters:
    
    mediaConfigs - An array of media configuration instances.
    
    Returns:
    
    An array of the video frame sizes.
  - fromFrameSizes
```
public static WOWZMediaConfig[] fromFrameSizes(WOWZSize[] frameSizes)
```
    Gets an array of media configurations from an array of video frame sizes.
    
    Parameters:
    
    frameSizes - An array of video frame sizes.
    
    Returns:
    
    An array of media configurations created with default values for properties other than the video frame size.
  - setLowBandwidthScalingFactor
```
public void setLowBandwidthScalingFactor(float lowBandwidthScalingFactor)
```
    The factor by which to scale the bitrate in low-bandwidth conditions. Valid range is 0.0 to 1.0; all other values are ignored. Specify 0.0 to instruct the encoder to choose the best value; specify 1.0 to instruct the encoder to not throttle the bitrate.
    
    Parameters:
    
    lowBandwidthScalingFactor - The default is 0.75.
  - getLowBandwidthScalingFactor
```
public float getLowBandwidthScalingFactor()
```
  - setFrameRateLowBandwidthSkipCount
```
public void setFrameRateLowBandwidthSkipCount(int frameRateLowBandwidthSkipCount)
```
    The number of frames to skip when the encoder can't keep up with the broadcaster. In poor network conditions the encoder will continue to send frames to the broadcaster but will skip frames to conserve bandwidth. The maximum number of frames that can be skipped equals the keyframe interval minus one. For example, setting the skip count to 29 with a keyframe interval of 30 will produce a keyframe-only stream; setting to 1 will never skip frames.
    
    Parameters:
    
    frameRateLowBandwidthSkipCount - The default is 4, which skips every fourth frame.
  - getFrameRateLowBandwidthSkipCount
```
public int getFrameRateLowBandwidthSkipCount()
```
  - setFrameBufferSizeMultiplier
```
public void setFrameBufferSizeMultiplier(int frameBufferSizeMultiplier)
```
    The value by which to multiply the video frame rate to determine the number of frames to buffer before the encoder starts to throttle bitrate and/or frame rate. For example, if the frame rate is 30 and the videoFrameBufferSizeMultiplier is 5, the encoder will buffer 150 (5 x 30) frames before throttling. Specifying 0 instructs the encoder to choose the best value.
    
    Parameters:
    
    frameBufferSizeMultiplier - The default is 4.
  - getFrameBufferSizeMultiplier
```
public int getFrameBufferSizeMultiplier()
```
  - setABREnabled
```
public void setABREnabled(boolean abrEnabled)
```
    Enables adaptive bitrate (ABR) streaming.
    
    Parameters:
    
    abrEnabled - True to have the video bitrate adjust automatically based on bandwidth constraints; false otherwise.
  - isABREnabled
```
public boolean isABREnabled()
```
    Checks whether adaptive bitrate (ABR) streaming is enabled.
    
    Returns:
    
    True if ABR is enabled; false otherwise.
  - resetToDefaults
```
public void resetToDefaults()
```
  - compareTo
```
public int compareTo(WOWZMediaConfig other)
```
    Compares the frame size of this instance with another instance.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<WOWZMediaConfig>
    
    Parameters:
    
    other - The instance to use for comparison.
    
    Returns:
    
    -1 if this instance uses a smaller frame size than the specified instance, 0 if they're equal, or 1 if this instance uses a bigger frame size.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this instance with another to see if they use the same video frame size.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - The instance to use for comparison.
    
    Returns:
    
    True if the instances' frame sizes are equal; false otherwise.
  - set
```
public void set(WOWZMediaConfig 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.
  - getVideoFrameSize
```
public WOWZSize getVideoFrameSize()
```
    Gets the video frame size.
    
    Returns:
    
    The frame size, in pixels.
  - setVideoFrameSize
```
public void setVideoFrameSize(WOWZSize videoSize)
```
    Sets the video frame size using the values from the specified instance. Frame width should always be greater than frame height (landscape orientation). If the specified frame size isn't landscape, the width and height will be swapped so that the frame is landscape oriented.
    
    Parameters:
    
    videoSize - An instance with the property values to use.
  - setVideoFrameSize
```
public void setVideoFrameSize(int width,
                              int height)
```
    Sets the video frame size using the specified values. Frame width should always be greater than frame height (landscape orientation). If the specified frame size isn't landscape, the width and height will be swapped so that the frame is landscape oriented.
    
    Parameters:
    
    width - The width of the video frame, in pixels.
    
    height - The height of the video frame, in pixels.
  - getVideoFrameWidth
```
public int getVideoFrameWidth()
```
    Gets the video frame width.
    
    Returns:
    
    The frame width, in pixels.
  - setVideoFrameWidth
```
public void setVideoFrameWidth(int width)
```
    Sets the video frame width; should be greater than the frame height.
    
    Parameters:
    
    width - The frame width, in pixels).
  - getVideoFrameHeight
```
public int getVideoFrameHeight()
```
    Gets the video frame height.
    
    Returns:
    
    The frame height, in pixels.
  - setVideoFrameHeight
```
public void setVideoFrameHeight(int height)
```
    Sets the video frame height; should be less than the frame width.
    
    Parameters:
    
    height - The video height, in pixels.
  - getVideoRotation
```
public int getVideoRotation()
```
    Gets the rotation angle of the video source, with 0 being the natural landscape orientation and 90 being the natural portrait orientation. 180 and 270, respectively, are the inverted landscape and portrait orientations.
    
    Returns:
    
    The rotation, in degrees, of the device's orientation.
  - setVideoRotation
```
public void setVideoRotation(int videoRotation)
```
    Sets the rotation angle of the video source, with 0 being the natural landscape orientation and 90 being the natural portrait orientation. 180 and 270, respectively, are the inverted landscape and portrait orientations.
    
    Parameters:
    
    videoRotation - The rotation, in degrees, of the device's orientation.
  - getVideoBitRate
```
public int getVideoBitRate()
```
    Gets the video bitrate.
    
    Returns:
    
    The video bitrate of the stream, in kbps.
  - setVideoBitRate
```
public void setVideoBitRate(int videoBitRate)
```
    Sets the video bitrate.
    
    Parameters:
    
    videoBitRate - The video bitrate of the stream, in kbps.
  - getVideoFramerate
```
public int getVideoFramerate()
```
    Gets the video frame rate.
    
    Returns:
    
    The video frame rate, in fps.
  - setVideoFramerate
```
public void setVideoFramerate(int videoFrameRate)
```
    Sets the video frame rate.
    
    Parameters:
    
    videoFrameRate - The video frame rate, in fps.
  - getVideoKeyFrameInterval
```
public int getVideoKeyFrameInterval()
```
    Gets the keyframe interval, which is the number of frames between keyframes.
    
    Returns:
    
    The keyframe interval.
  - setVideoKeyFrameInterval
```
public void setVideoKeyFrameInterval(int videoKeyFrameInterval)
```
    Sets the keyframe interval, which is the number of frames between keyframes.
    
    Parameters:
    
    videoKeyFrameInterval - The keyframe interval.
  - getVideoProfileLevel
```
public WOWZProfileLevel getVideoProfileLevel()
```
    Gets the H.264 profile level.
  - setVideoProfileLevel
```
public void setVideoProfileLevel(int profile,
                                 int level)
```
    Sets the H.264 profile.
    
    Parameters:
    
    profile - The profile identifier.
    
    level - The level identifier.
  - setVideoProfileLevel
```
public void setVideoProfileLevel(WOWZProfileLevel profileLevel)
```
    Sets the H.264 profile.
    
    Parameters:
    
    profileLevel - The profile level.
  - getAudioChannels
```
public int getAudioChannels()
```
    Gets the number of audio channels.
    
    Returns:
    
    The number of audio channels, AUDIO_CHANNELS_STEREO or AUDIO_CHANNELS_MONO.
  - setAudioChannels
```
public void setAudioChannels(int audioChannels)
```
    Sets the number of audio channels.
    
    Parameters:
    
    audioChannels - The number of audio channels, AUDIO_CHANNELS_STEREO or AUDIO_CHANNELS_MONO.
  - getAudioSampleRate
```
public int getAudioSampleRate()
```
    Gets the audio sample rate.
    
    Returns:
    
    The sample rate, in Hz.
  - setAudioSampleRate
```
public int setAudioSampleRate(int audioSampleRate)
```
    Sets the the audio sample rate. Supported sample rates at SUPPORTED_AUDIO_SAMPLE_RATES. If an invalid rate is specified, the next-highest supported rate will be used instead.
    
    Parameters:
    
    audioSampleRate - The sample rate, in Hz.
    
    Returns:
    
    The actual sample rate selected.
  - getAudioBitRate
```
public int getAudioBitRate()
```
    Gets the audio bitrate.
    
    Returns:
    
    The bitrate of the audio stream, in kbps.
  - setAudioBitRate
```
public void setAudioBitRate(int audioBitRate)
```
    Sets the audio bitrate.
    
    Parameters:
    
    audioBitRate - The bitrate of the audio stream, in kbps.
  - isVideoEnabled
```
public boolean isVideoEnabled()
```
    Checks whether video streaming is enabled.
    
    Returns:
    
    True if video streaming is enabled; false otherwise.
  - getHLSBackupURL
```
public java.lang.String getHLSBackupURL()
```
    Gets the HLS playback URL.
    
    Returns:
    
    The HLS playback URL, or null if none is specified.
  - getIsPlayback
```
public java.lang.Boolean getIsPlayback()
```
    Checks whether the config is used for playback.
    
    Returns:
    
    True if the config is for playback; false otherwise.
  - setIsPlayback
```
public void setIsPlayback(boolean isPlayback)
```
    Specifies whether the config is used for playback.
  - setHLSBackupURL
```
public void setHLSBackupURL(java.lang.String backupURL)
```
    Specifies an Apple HLS URL to use for playback. Can be used as a fallback for ultra low latency streams from Wowza Streaming Cloud; note, however, that Apple HLS streams experience greater latency than WebSocket streams.
    
    Parameters:
    
    backupURL - An Apple HLS URL.
  - getPlayerExampleAutoconfig
```
public java.lang.String getPlayerExampleAutoconfig()
```
  - setPlayerExampleAutoconfig
```
public void setPlayerExampleAutoconfig(java.lang.String configName)
```
  - isHLSEnabled
```
public boolean isHLSEnabled()
```
    Checks whether HLS playback is enabled.
    
    Returns:
    
    True if HLS primary playback is enabled; false otherwise.
  - setHLSEnabled
```
public void setHLSEnabled(boolean useHLS)
```
    Specifies primary playback over Apple HLS. The default is false, which means Apple HLS will only be used as a backup, or fallback, if playback over the primary connection is unsuccessful.
    
    Parameters:
    
    useHLS - True to use HLS as the primary playback protocol; false to use HLS as the backup.
  - setVideoEnabled
```
public void setVideoEnabled(boolean videoEnabled)
```
    Enables video streaming.
    
    Parameters:
    
    videoEnabled - True to enable video streaming; false otherwise.
  - isAudioEnabled
```
public boolean isAudioEnabled()
```
    Checks whether audio streaming is enabled.
    
    Returns:
    
    True if audio streaming is enabled; false otherwise.
  - setAudioEnabled
```
public void setAudioEnabled(boolean audioEnabled)
```
    Enables audio streaming.
    
    Parameters:
    
    audioEnabled - True to enable audio streaming; false otherwise.
  - getPresetLabel
```
public java.lang.String getPresetLabel()
```
    Gets the label for a preset configuration, for example, "1080p."
    
    Returns:
    
    The preset label, or null if this instance isn't one of the preset configurations that has a predefined label.
  - getPresetLabelByFrameSize
```
public java.lang.String getPresetLabelByFrameSize()
```
    Gets the label for a preset configuration, for example "1080p," that matches this instance's video frame size.
    
    Returns:
    
    The preset label, or null if this instance doesn't match one of the presets with a predefined label by video frame size.
  - getLabel
```
public java.lang.String getLabel(boolean withFrameSize,
                                 boolean withPreset,
                                 boolean withBitrate)
```
    Deprecated.
    
    See Also:
    
    getLabel(boolean, boolean, boolean, boolean)
  - getLabel
```
public java.lang.String getLabel(boolean withFrameSize,
                                 boolean withPreset,
                                 boolean withAspect,
                                 boolean withBitrate)
```
    Gets a configurable, human-readable representation of this configuration instance.
    
    Parameters:
    
    withFrameSize - Indicates whether the frame size should be included.
    
    withPreset - Indicates whether the preset label for the frame size should be included.
    
    withAspect - Indicates whether the aspect ratio should be displayed with the frame size.
    
    withBitrate - Indicates whether the video bitrate should be included.
    
    Returns:
    
    A string representation of this config.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toDataMap
```
public WOWZDataMap toDataMap(WOWZDataMap dataMap)
```
    Gets a WOWZDataMap that contains the configuration properties.
    
    Parameters:
    
    dataMap - A previously allocated data map in which to add the configuration properties.
    
    Returns:
    
    The updated data map.
  - toDataMap
```
public WOWZDataMap toDataMap()
```
    Gets a WOWZDataMap that contains the configuration properties.
    
    Returns:
    
    A data map that contains the configuration properties.

Class WOWZMediaConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_VIDEO_FRAME_WIDTH

DEFAULT_VIDEO_FRAME_HEIGHT

DEFAULT_VIDEO_FRAME_SIZE

DEFAULT_VIDEO_BITRATE

DEFAULT_VIDEO_FRAME_RATE

DEFAULT_VIDEO_KEYFRAME_INTERVAL

DEFAULT_AUDIO_SAMPLE_RATE

DEFAULT_AUDIO_BITRATE

SUPPORTED_AUDIO_SAMPLE_RATES

RESIZE_TO_ASPECT

CROP_TO_FRAME

FILL_VIEW

FILL_FRAME

DEFAULT_SCALE_MODE

ORIENTATION_LANDSCAPE

ORIENTATION_PORTRAIT

ORIENTATION_LANDSCAPE_INVERTED

ORIENTATION_PORTRAIT_INVERTED

ALWAYS_LANDSCAPE

ALWAYS_PORTRAIT

SAME_AS_SOURCE

AUDIO_CHANNELS_STEREO

AUDIO_CHANNELS_MONO

FRAME_SIZE_176x144

FRAME_SIZE_320x240

FRAME_SIZE_352x288

FRAME_SIZE_640x480

FRAME_SIZE_960x540

FRAME_SIZE_1280x720

FRAME_SIZE_1440x1080

FRAME_SIZE_1920x1080

FRAME_SIZE_3840x2160

PRESET_CONFIGS

DEFAULT_VIDEO_BITRATE_SCALING_FACTOR

DEFAULT_VIDEO_FRAME_BUFFER_MULTIPLIER

DEFAULT_VIDEO_FRAME_SKIP_COUNT

Constructor Detail

WOWZMediaConfig

WOWZMediaConfig

Method Detail

isValidScaleMode

isLandscape

isLandscapeRotation

orientationLabel

isPortrait

isPortraitRotation

rotationToOrientation

surfaceRotationToOrientation

orientationToRotation

orientationToSurfaceRotation

keyFrameIntervalFramesToSeconds

bitrateLabel

toFrameSizes

fromFrameSizes

setLowBandwidthScalingFactor

getLowBandwidthScalingFactor

setFrameRateLowBandwidthSkipCount

getFrameRateLowBandwidthSkipCount

setFrameBufferSizeMultiplier

getFrameBufferSizeMultiplier

setABREnabled

isABREnabled

resetToDefaults

compareTo

equals

set

getVideoFrameSize

setVideoFrameSize

setVideoFrameSize

getVideoFrameWidth

setVideoFrameWidth

getVideoFrameHeight

setVideoFrameHeight

getVideoRotation