org.red5.server.api
Interface IBandwidthConfigure

All Superinterfaces:
Cloneable
All Known Subinterfaces:
IConnectionBWConfig
All Known Implementing Classes:
SimpleBandwidthConfigure, SimpleConnectionBWConfig

public interface IBandwidthConfigure
extends Cloneable

Interface for setting/getting bandwidth configure. Two properties are provided for bandwidth configuration. The property "channelBandwidth" is used to configure the bandwidth of each channel. The property "channelInitialBurst" is used to configure the initial bytes that can be sent to client in each channel.

Author:
The Red5 Project (red5@osflash.org), Steven Gong (steven.gong@gmail.com)

Field Summary
static int AUDIO_CHANNEL
           
static int DATA_CHANNEL
           
static int MAX_CHANNEL_CONFIG_COUNT
           
static int OVERALL_CHANNEL
           
static int VIDEO_CHANNEL
           
 
Method Summary
 long[] getChannelBandwidth()
          Return the bandwidth configure for 3 channels: audio, video, data and the overall bandwidth.
 long[] getChannelInitialBurst()
          Return the byte count of initial burst value for 3 channels: audio, video, data and the overall bandwidth.
 

Field Detail

AUDIO_CHANNEL

static final int AUDIO_CHANNEL
See Also:
Constant Field Values

VIDEO_CHANNEL

static final int VIDEO_CHANNEL
See Also:
Constant Field Values

DATA_CHANNEL

static final int DATA_CHANNEL
See Also:
Constant Field Values

OVERALL_CHANNEL

static final int OVERALL_CHANNEL
See Also:
Constant Field Values

MAX_CHANNEL_CONFIG_COUNT

static final int MAX_CHANNEL_CONFIG_COUNT
See Also:
Constant Field Values
Method Detail

getChannelBandwidth

long[] getChannelBandwidth()
Return the bandwidth configure for 3 channels: audio, video, data and the overall bandwidth. The unit is bit per second. A value of -1 means "don't care" so that there's no limit on bandwidth for that channel. The last element is the overall bandwidth. If it's not -1, the value of the first three elements will be ignored.

Returns:
The 4-element array of bandwidth configure.

getChannelInitialBurst

long[] getChannelInitialBurst()
Return the byte count of initial burst value for 3 channels: audio, video, data and the overall bandwidth. If the value is -1, the default will be used per the implementation of bandwidth controller.

Returns:
The 4-element array of byte count of initial burst value.


Copyright © 2006-2009 The Red5 Project