WZMediaConfig (GoCoder SDK Android API)

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

All Implemented Interfaces:

Serializable, Comparable<WZMediaConfig>

Direct Known Subclasses:

WZStreamConfig
```
public class WZMediaConfig
extends Object
implements Comparable<WZMediaConfig>, Serializable
```
The WZMediaConfig class provides configuration properties for the capture and encoding of video and audio

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 framerate (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 stream 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 video frame height (480 px)
`static int`	`DEFAULT_VIDEO_FRAME_RATE` The default value for the video framerate (30 fps)
`static WZSize`	`DEFAULT_VIDEO_FRAME_SIZE` The default value for the video stream size, in pixels
`static int`	`DEFAULT_VIDEO_FRAME_SKIP_COUNT`
`static int`	`DEFAULT_VIDEO_FRAME_WIDTH` The default value for the video frame width (640 px)
`static int`	`DEFAULT_VIDEO_KEYFRAME_INTERVAL` The default value for the video 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 WZMediaConfig`	`FRAME_SIZE_1280x720` An identifier for a preset configuration representing 720p HD video
`static WZMediaConfig`	`FRAME_SIZE_1440x1080` An identifier for a preset configuration representing 720p HD video
`static WZMediaConfig`	`FRAME_SIZE_176x144` An identifier for a preset configuration appropriate for Quarter CIF (QCIF)
`static WZMediaConfig`	`FRAME_SIZE_1920x1080` An identifier for a preset configuration representing 1080p HD video
`static WZMediaConfig`	`FRAME_SIZE_320x240` An identifier for a preset configuration appropriate for Quarter Video Graphics Array (QVGA)
`static WZMediaConfig`	`FRAME_SIZE_352x288` An identifier for a preset configuration appropriate for Common Intermediate Format (CIF)
`static WZMediaConfig`	`FRAME_SIZE_3840x2160` An identifier for a preset configuration representing 4k Ultra HD video
`static WZMediaConfig`	`FRAME_SIZE_640x480` An identifier for a preset configuration appropriate for Video Graphics Array (VGA)
`static WZMediaConfig`	`FRAME_SIZE_960x540` An identifier for a preset configuration appropriate for use on a high bandwidth connection
`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 WZMediaConfig[]`	`PRESET_CONFIGS` An array containing each of the preset configuration identifiers, presorted from lowest video frame size to highest
`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 bwan.
`static int[]`	`SUPPORTED_AUDIO_SAMPLE_RATES` The audio sample rates supported

Constructor Summary

Constructors
Constructor and Description
`WZMediaConfig()` The default constructor
`WZMediaConfig(WZMediaConfig other)` Construct a new 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 String`	`bitrateLabel(int bps)` Generates a human-readable representation of a bitrate value (e.g.
`int`	`compareTo(WZMediaConfig other)` Compare this instance with the specified instance based on video frame size
`boolean`	`equals(Object other)` Compare this instance with the specified instance for equality based on video frame size
`static WZMediaConfig[]`	`fromFrameSizes(WZSize[] frameSizes)` Generates an array of media configurations from an array of video frame sizes
`int`	`getAudioBitRate()` Returns the audio stream bitrate
`int`	`getAudioChannels()` Returns the no.
`int`	`getAudioSampleRate()` Returns the audio sample rate
`int`	`getFrameBufferSizeMultiplier()`
`int`	`getFrameRateLowBandwidthSkipCount()`
`String`	`getLabel(boolean withFrameSize, boolean withPreset, boolean withBitrate)` Deprecated.
`String`	`getLabel(boolean withFrameSize, boolean withPreset, boolean withAspect, boolean withBitrate)` Return a configurable, human-readable representation of this configuration instance (e.g.
`float`	`getLowBandwidthScalingFactor()`
`String`	`getPresetLabel()` Returns the predefined label describing a preset configuration (e.g.
`String`	`getPresetLabelByFrameSize()` Returns the predefined label for a preset configuration (e.g.
`int`	`getVideoBitRate()` Returns the video stream bitrate
`int`	`getVideoFrameHeight()` Returns the video frame height
`int`	`getVideoFramerate()` Returns the video framerate
`WZSize`	`getVideoFrameSize()` Returns the video frame size value
`int`	`getVideoFrameWidth()` Returns the video frame width
`int`	`getVideoKeyFrameInterval()` Returns the video keyframe interval
`WZProfileLevel`	`getVideoProfileLevel()` Get the H.264 profile level
`int`	`getVideoRotation()` Returns the rotation, in degrees, of the video source with 0 being the natural landscape orientation and 90 being the natural portrait orientation 180 and 270 are the inverted landscape and portrait orientations respectively
`boolean`	`isABREnabled()` Indicates if Adjustable Bitrate (ABR) is enabled or not
`boolean`	`isAudioEnabled()` Indicates if audio streaming is enabled
`static boolean`	`isLandscape(int orientation)` Indicates if the orientation identifier specified matches one of the landscape identifiers
`static boolean`	`isLandscapeRotation(int rotation)` Indicates if the rotation angle specifies a landscape orientation or not
`static boolean`	`isPortrait(int orientation)` Indicates if the orientation identifier specified matches one of the portrait identifiers
`static boolean`	`isPortraitRotation(int rotation)` Indicates if the rotation angle specifies a portrait orientation or not
`static boolean`	`isValidScaleMode(int scaleMode)` Returns true if the value provided is a valid value for the scale mode property
`boolean`	`isVideoEnabled()` Indicates if video streaming is enabled
`static int`	`keyFrameIntervalFramesToSeconds(int frames, int frameRate)` Converts between # of frames to fps given the frame rate
`static String`	`orientationLabel(int orientation)` Returns 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 one of the orientation identifiers.
`void`	`set(WZMediaConfig other)` Update the property values of this instance with the property values from the specified instance
`void`	`setABREnabled(boolean abrEnabled)` Enable or disable Adjustable Bitrate (ABR)
`void`	`setAudioBitRate(int audioBitRate)` Set the audio stream bitrate
`void`	`setAudioChannels(int audioChannels)` Set the no.
`void`	`setAudioEnabled(boolean audioEnabled)` Enable or disable audio streaming
`int`	`setAudioSampleRate(int audioSampleRate)` Set the the audio sample rate.
`void`	`setFrameBufferSizeMultiplier(int frameBufferSizeMultiplier)` The FrameBufferSizeMultiplier property is the value by which to multiply the video frame rate to derive the number of video frames to buffer before the encoder starts to throttle bitrate and/or frame rate.
`void`	`setFrameRateLowBandwidthSkipCount(int frameRateLowBandwidthSkipCount)` The FrameRateLowBandwidthSkipCount property is the number of frames to skip when the encoder cannot keep up with the broadcaster.
`void`	`setLowBandwidthScalingFactor(float lowBandwidthScalingFactor)` The LowBandwidthScalingFactor property is the factor by which to scale the desired bitrate in low bandwidth conditions.
`void`	`setVideoBitRate(int videoBitRate)` Set the video stream bitrate
`void`	`setVideoEnabled(boolean videoEnabled)` Enable or disable video streaming
`void`	`setVideoFrameHeight(int height)` Set the video frame height Frame sizes should always be specified using landscape-based dimensions (i.e.
`void`	`setVideoFramerate(int videoFrameRate)` Set the video framerate
`void`	`setVideoFrameSize(int width, int height)` Set the video frame size using the specified values.
`void`	`setVideoFrameSize(WZSize videoSize)` Set the video frame size using the values from the specified instance Frame sizes should always be specified using landscape-based dimensions (i.e.
`void`	`setVideoFrameWidth(int width)` Set the video frame width Frame sizes should always be specified using landscape-based dimensions (i.e.
`void`	`setVideoKeyFrameInterval(int videoKeyFrameInterval)` Set the video keyframe interval
`void`	`setVideoProfileLevel(int profile, int level)` Set the H.264 profile
`void`	`setVideoProfileLevel(WZProfileLevel profileLevel)` Set the H.264 profile
`void`	`setVideoRotation(int videoRotation)` Specify the rotation, in degrees, of the video source with 0 being the natural landscape orientation and 90 being the natural portrait orientation 180 and 270 are the inverted landscape and portrait orientations respectively
`static int`	`surfaceRotationToOrientation(int rotation)` Deprecated. Use `rotationToOrientation(int)` instead
`WZDataMap`	`toDataMap()` Returns a `WZDataMap` containing the configuration properties
`WZDataMap`	`toDataMap(WZDataMap dataMap)` Returns a `WZDataMap` containing the configuration properties
`static WZSize[]`	`toFrameSizes(WZMediaConfig[] mediaConfigs)` Generates an array of the video frame sizes contained in an array of media configuration instances
`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 video frame width (640 px)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_HEIGHT
```
public static final int DEFAULT_VIDEO_FRAME_HEIGHT
```
    The default value for the video frame height (480 px)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_FRAME_SIZE
```
public static final WZSize DEFAULT_VIDEO_FRAME_SIZE
```
    The default value for the video stream size, in pixels
  - DEFAULT_VIDEO_BITRATE
```
public static final int DEFAULT_VIDEO_BITRATE
```
    The default value for the video stream 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 framerate (30 fps)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VIDEO_KEYFRAME_INTERVAL
```
public static final int DEFAULT_VIDEO_KEYFRAME_INTERVAL
```
    The default value for the video 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 framerate (64000 bps)
    
    See Also:
    
    Constant Field Values
  - SUPPORTED_AUDIO_SAMPLE_RATES
```
public static final int[] SUPPORTED_AUDIO_SAMPLE_RATES
```
    The audio sample rates supported
  - 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 is captured while the video input device or source is in a 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 a 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 bwan.
    
    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 WZMediaConfig FRAME_SIZE_176x144
```
    An identifier for a preset configuration appropriate for Quarter CIF (QCIF)
    video resolution: 320x240, video bitrate: 280 kbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_320x240
```
public static final WZMediaConfig FRAME_SIZE_320x240
```
    An identifier for a preset configuration appropriate for Quarter Video Graphics Array (QVGA)
    video resolution: 320x240, video bitrate: 280 kbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_352x288
```
public static final WZMediaConfig FRAME_SIZE_352x288
```
    An identifier for a preset configuration appropriate for Common Intermediate Format (CIF)
    video resolution: 320x240, video bitrate: 1 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_640x480
```
public static final WZMediaConfig FRAME_SIZE_640x480
```
    An identifier for a preset configuration appropriate for Video Graphics Array (VGA)
    video resolution: 640x480, video bitrate: 1.5 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_960x540
```
public static final WZMediaConfig FRAME_SIZE_960x540
```
    An identifier for a preset configuration appropriate for use on a high bandwidth connection
    video resolution: 960x540, video bitrate: 1.5 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_1280x720
```
public static final WZMediaConfig FRAME_SIZE_1280x720
```
    An identifier for a preset configuration representing 720p HD video
    video resolution: 1280x720, video bitrate: 3.75 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_1440x1080
```
public static final WZMediaConfig FRAME_SIZE_1440x1080
```
    An identifier for a preset configuration representing 720p HD video
    video resolution: 1440x1080, video bitrate: 5 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_1920x1080
```
public static final WZMediaConfig FRAME_SIZE_1920x1080
```
    An identifier for a preset configuration representing 1080p HD video
    video resolution: 1920x1080, video bitrate: 5 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - FRAME_SIZE_3840x2160
```
public static final WZMediaConfig FRAME_SIZE_3840x2160
```
    An identifier for a preset configuration representing 4k Ultra HD video
    video resolution: 3840x2160, video bitrate: 8 mbps, framerate: 30 fps, keyframe interval: 30 frames audio sample rate: 44.1kHz, audio bitrate: 64 kbps
  - PRESET_CONFIGS
```
public static final WZMediaConfig[] PRESET_CONFIGS
```
    An array containing each of the preset configuration identifiers, presorted from lowest video frame size to highest
  - 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
  - WZMediaConfig
```
public WZMediaConfig()
```
    The default constructor
  - WZMediaConfig
```
public WZMediaConfig(WZMediaConfig other)
```
    Construct a new instance using the property values from the specified instance
    
    Parameters:
    
    other - The instance to replicate
- Method Detail
  - isValidScaleMode
```
public static boolean isValidScaleMode(int scaleMode)
```
    Returns true if the value provided is a valid value for the scale mode property
    
    Parameters:
    
    scaleMode - a scale mode property value
    
    Returns:
    
    true if the value provided is a valid value for the scale mode property, false otherwise
  - isLandscape
```
public static boolean isLandscape(int orientation)
```
    Indicates if the orientation identifier specified 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)
```
    Indicates if the rotation angle specifies a landscape orientation or not
    
    Parameters:
    
    rotation - rotation angle, in degrees
    
    Returns:
    
    true if the specified rotation angle specifies a landscape orientation, false otherwise
  - orientationLabel
```
public static String orientationLabel(int orientation)
```
    Returns a string representation of the specified orientation
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED
    
    Returns:
    
    "portrait" or "landscape"
  - isPortrait
```
public static boolean isPortrait(int orientation)
```
    Indicates if the orientation identifier specified matches one of the portrait identifiers
    
    Parameters:
    
    orientation - ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE_INVERTED, or ORIENTATION_PORTRAIT_INVERTED
    
    Returns:
    
    true if the specified identifier is one of the portrait identifiers, false otherwise
  - isPortraitRotation
```
public static boolean isPortraitRotation(int rotation)
```
    Indicates if the rotation angle specifies a portrait orientation or not
    
    Parameters:
    
    rotation - rotation angle, in degrees
    
    Returns:
    
    true if the specified rotation angle specifies a portrait orientation, false otherwise
  - rotationToOrientation
```
public static int rotationToOrientation(int rotation)
```
    Converts a surface rotation angle to one of the orientation identifiers.
    ORIENTATION_LANDSCAPE represents 0° followed, in a clockwise manner at 90° increments, by ORIENTATION_PORTRAIT (90°), ORIENTATION_LANDSCAPE_INVERTED (180°), and ORIENTATION_PORTRAIT_INVERTED (270°)
    
    Parameters:
    
    rotation - A surface rotation angle, in degrees
    
    Returns:
    
    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°), ORIENTATION_PORTRAIT (90°), ORIENTATION_LANDSCAPE_INVERTED (180°), or ORIENTATION_PORTRAIT_INVERTED (270°)
    
    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 # of frames to fps given the frame rate
    
    Parameters:
    
    frames - the no. of frame between keyframes
    
    frameRate - the frame rate
    
    Returns:
    
    the no. of seconds in between key frames
  - bitrateLabel
```
public static String bitrateLabel(int bps)
```
    Generates a human-readable representation of a bitrate value (e.g. "800bps", "1.5kbps")
    
    Parameters:
    
    bps - A bitrate value
    
    Returns:
    
    A string representation of the bitrate with a unit suffix appended
  - toFrameSizes
```
public static WZSize[] toFrameSizes(WZMediaConfig[] mediaConfigs)
```
    Generates 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 WZMediaConfig[] fromFrameSizes(WZSize[] frameSizes)
```
    Generates 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 LowBandwidthScalingFactor property is the factor by which to scale the desired bitrate in low bandwidth conditions. Valid range is 0.0 to 1.0; any other value will be ignored. Setting a value of 0.0 indicates that the encoder should choose the best value; setting a value of 1.0 indicates that bitrate will never be throttled.
    
    Parameters:
    
    lowBandwidthScalingFactor - The default is 0.75
  - getLowBandwidthScalingFactor
```
public float getLowBandwidthScalingFactor()
```
  - setFrameRateLowBandwidthSkipCount
```
public void setFrameRateLowBandwidthSkipCount(int frameRateLowBandwidthSkipCount)
```
    The FrameRateLowBandwidthSkipCount property is the number of frames to skip when the encoder cannot keep up with the broadcaster. In low bandwidth conditions the encoder will skip frames to conserve bandwidth but still send consistent frames so the encoder can produce smooth playback. The maximum number of frames that can be skipped is equal to the key frame interval minus one - i.e. setting this to 29 with a key frame interval of 30 will produce a key frame only stream, setting to 1 will never skip frames.
    
    Parameters:
    
    frameRateLowBandwidthSkipCount - The default is 4 meaning skip 1 of every 4 frames
  - getFrameRateLowBandwidthSkipCount
```
public int getFrameRateLowBandwidthSkipCount()
```
  - setFrameBufferSizeMultiplier
```
public void setFrameBufferSizeMultiplier(int frameBufferSizeMultiplier)
```
    The FrameBufferSizeMultiplier property is the value by which to multiply the video frame rate to derive the number of video 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 * 30) frames before throttling. Setting a value of 0 indicates that the encoder should choose the best value.
    
    Parameters:
    
    frameBufferSizeMultiplier - The default value is 4
  - getFrameBufferSizeMultiplier
```
public int getFrameBufferSizeMultiplier()
```
  - setABREnabled
```
public void setABREnabled(boolean abrEnabled)
```
    Enable or disable Adjustable Bitrate (ABR)
    
    Parameters:
    
    abrEnabled - true to have the bitrate of the video stream automatically adjusted based on bandwidth constraints, false otherwise
  - isABREnabled
```
public boolean isABREnabled()
```
    Indicates if Adjustable Bitrate (ABR) is enabled or not
    
    Returns:
    
    true if the bitrate of the video stream will be automatically adjusted based on bandwidth constraints, false otherwise
  - resetToDefaults
```
public void resetToDefaults()
```
  - compareTo
```
public int compareTo(WZMediaConfig other)
```
    Compare this instance with the specified instance based on video frame size
    
    Specified by:
    
    compareTo in interface Comparable<WZMediaConfig>
    
    Parameters:
    
    other - The instance to be used for comparison
    
    Returns:
    
    -1 if this instance is less than the specified instance, 0 if equal, or 1 if greater
  - equals
```
public boolean equals(Object other)
```
    Compare this instance with the specified instance for equality based on video frame size
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - The instance to be used for comparison
    
    Returns:
    
    true> is the instances are equal, false> otherwise
  - set
```
public void set(WZMediaConfig 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
  - getVideoFrameSize
```
public WZSize getVideoFrameSize()
```
    Returns the video frame size value
    
    Returns:
    
    The video frame size (pixels)
  - setVideoFrameSize
```
public void setVideoFrameSize(WZSize videoSize)
```
    Set the video frame size using the values from the specified instance Frame sizes should always be specified using landscape-based dimensions (i.e. width > height). If the specified size does not represent a landscape-based dimension, the width and height will be swapped so that the resulting dimension is landscape oriented
    
    Parameters:
    
    videoSize - An instance with the property values to use
  - setVideoFrameSize
```
public void setVideoFrameSize(int width,
                              int height)
```
    Set the video frame size using the specified values. Frame sizes should always be specified using landscape-based dimensions (i.e. width > height) If the specified size does not represent a landscape-based dimension, the width and height will be swapped so that the resulting dimension is landscape oriented
    
    Parameters:
    
    width - The width of the video frame (pixels)
    
    height - The height of the video frame (pixels)
  - getVideoFrameWidth
```
public int getVideoFrameWidth()
```
    Returns the video frame width
    
    Returns:
    
    The video width (pixels)
  - setVideoFrameWidth
```
public void setVideoFrameWidth(int width)
```
    Set the video frame width Frame sizes should always be specified using landscape-based dimensions (i.e. width > height)
    
    Parameters:
    
    width - The video frame width (pixels)
  - getVideoFrameHeight
```
public int getVideoFrameHeight()
```
    Returns the video frame height
    
    Returns:
    
    The video frame height (pixels)
  - setVideoFrameHeight
```
public void setVideoFrameHeight(int height)
```
    Set the video frame height Frame sizes should always be specified using landscape-based dimensions (i.e. width > height)
    
    Parameters:
    
    height - the video height (pixels)
  - getVideoRotation
```
public int getVideoRotation()
```
    Returns the rotation, in degrees, of the video source with 0 being the natural landscape orientation and 90 being the natural portrait orientation 180 and 270 are the inverted landscape and portrait orientations respectively
    
    Returns:
    
    the rotation, in degrees, of the device's orientation
  - setVideoRotation
```
public void setVideoRotation(int videoRotation)
```
    Specify the rotation, in degrees, of the video source with 0 being the natural landscape orientation and 90 being the natural portrait orientation 180 and 270 are the inverted landscape and portrait orientations respectively
    
    Parameters:
    
    videoRotation - the rotation, in degrees, of the device's orientation
  - getVideoBitRate
```
public int getVideoBitRate()
```
    Returns the video stream bitrate
    
    Returns:
    
    The video stream bitrate (kbps)
  - setVideoBitRate
```
public void setVideoBitRate(int videoBitRate)
```
    Set the video stream bitrate
    
    Parameters:
    
    videoBitRate - The video stream bitrate (kbps)
  - getVideoFramerate
```
public int getVideoFramerate()
```
    Returns the video framerate
    
    Returns:
    
    The video framerate (fps)
  - setVideoFramerate
```
public void setVideoFramerate(int videoFrameRate)
```
    Set the video framerate
    
    Parameters:
    
    videoFrameRate - The video framerate (fps)
  - getVideoKeyFrameInterval
```
public int getVideoKeyFrameInterval()
```
    Returns the video keyframe interval
    
    Returns:
    
    The video keyframe interval (# of frames between keyframes)
  - setVideoKeyFrameInterval
```
public void setVideoKeyFrameInterval(int videoKeyFrameInterval)
```
    Set the video keyframe interval
    
    Parameters:
    
    videoKeyFrameInterval - The keyframe interval (# of frames between keyframes)
  - getVideoProfileLevel
```
public WZProfileLevel getVideoProfileLevel()
```
    Get the H.264 profile level
  - setVideoProfileLevel
```
public void setVideoProfileLevel(int profile,
                                 int level)
```
    Set the H.264 profile
    
    Parameters:
    
    profile - The profile identifier
    
    level - The level identifier
    
    See Also:
    
    WZProfileLevel
  - setVideoProfileLevel
```
public void setVideoProfileLevel(WZProfileLevel profileLevel)
```
    Set the H.264 profile
    
    Parameters:
    
    profileLevel - The profile level
  - getAudioChannels
```
public int getAudioChannels()
```
    Returns the no. of audio channels
    
    Returns:
    
    the no. of audio channels AUDIO_CHANNELS_STEREO or AUDIO_CHANNELS_MONO
  - setAudioChannels
```
public void setAudioChannels(int audioChannels)
```
    Set the no. of audio channels
    
    Parameters:
    
    audioChannels - The no. of audio channels. AUDIO_CHANNELS_STEREO or AUDIO_CHANNELS_MONO
  - getAudioSampleRate
```
public int getAudioSampleRate()
```
    Returns the audio sample rate
    
    Returns:
    
    The sample rate (Hz)
  - setAudioSampleRate
```
public int setAudioSampleRate(int audioSampleRate)
```
    Set the the audio sample rate. Note that the list of audio sample rates supported is limited to those in SUPPORTED_AUDIO_SAMPLE_RATES. If a value not in this list is specified, the next highest value from the list of supported sample rates will be used instead.
    
    Parameters:
    
    audioSampleRate - The sample rate (Hz)
    
    Returns:
    
    The actual sample rate selected from the list of those supported
  - getAudioBitRate
```
public int getAudioBitRate()
```
    Returns the audio stream bitrate
    
    Returns:
    
    The audio stream bitrate (kbps)
  - setAudioBitRate
```
public void setAudioBitRate(int audioBitRate)
```
    Set the audio stream bitrate
    
    Parameters:
    
    audioBitRate - The audio stream bitrate (kbps)
  - isVideoEnabled
```
public boolean isVideoEnabled()
```
    Indicates if video streaming is enabled
    
    Returns:
    
    true> if video streaming is enabled, false> otherwise
  - setVideoEnabled
```
public void setVideoEnabled(boolean videoEnabled)
```
    Enable or disable video streaming
    
    Parameters:
    
    videoEnabled - true> if video streaming is enabled, false> otherwise
  - isAudioEnabled
```
public boolean isAudioEnabled()
```
    Indicates if audio streaming is enabled
    
    Returns:
    
    true> if audio streaming is enabled, false> otherwise
  - setAudioEnabled
```
public void setAudioEnabled(boolean audioEnabled)
```
    Enable or disable audio streaming
    
    Parameters:
    
    audioEnabled - true> if audio streaming is enabled, false> otherwise
  - getPresetLabel
```
public String getPresetLabel()
```
    Returns the predefined label describing a preset configuration (e.g. "1080p")
    
    Returns:
    
    The preset label or null if this instance is not one of the preset configurations that has a predefined label
  - getPresetLabelByFrameSize
```
public String getPresetLabelByFrameSize()
```
    Returns the predefined label for a preset configuration (e.g. "1080p") that matches this instance by video frame size
    
    Returns:
    
    The preset label or null if this instance does not match one of the presets with a predefined label by video frame size
  - getLabel
```
public String getLabel(boolean withFrameSize,
                       boolean withPreset,
                       boolean withBitrate)
```
    Deprecated.
    
    See Also:
    
    getLabel(boolean, boolean, boolean, boolean)
  - getLabel
```
public String getLabel(boolean withFrameSize,
                       boolean withPreset,
                       boolean withAspect,
                       boolean withBitrate)
```
    Return a configurable, human-readable representation of this configuration instance (e.g. "1280x720 (720p) @ 3.5kbps")
    
    Parameters:
    
    withFrameSize - indicates if the frame size should be included or not
    
    withPreset - indicates if the preset label for the frame size should be included or not
    
    withAspect - indicates if the aspect ratio should be displayed with the frame size or not
    
    withBitrate - indicates if the video bitrate should be included or not
    
    Returns:
    
    string representation of this config
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDataMap
```
public WZDataMap toDataMap(WZDataMap dataMap)
```
    Returns a WZDataMap containing the configuration properties
    
    Parameters:
    
    dataMap - a previouslly allocated data map in which to add the configuration properties
    
    Returns:
    
    the updated data map
  - toDataMap
```
public WZDataMap toDataMap()
```
    Returns a WZDataMap containing the configuration properties
    
    Returns:
    
    a data map containing the configuration properties

Class WZMediaConfig

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

WZMediaConfig

WZMediaConfig

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