Module webrtc.java

Package dev.onvoid.webrtc

Class RTCRtpCodecParameters

java.lang.Object

dev.onvoid.webrtc.RTCRtpCodecParameters

public class RTCRtpCodecParameters
extends Object

Describes the configuration parameters for a single media codec.

Author:

Alex Andres

Field Summary

Fields

Modifier and Type	Field	Description
int	channels	When present, indicates the number of audio channels (mono=1, stereo=2).
int	clockRate	The codec clock rate expressed in Hertz.
String	codecName	Used to identify the codec.
MediaType	mediaType	The media type of the codec.
Map<String,String>	parameters	The "format specific parameters" field from the "a=fmtp" line in the SDP corresponding to the codec, if one exists.
int	payloadType	The RTP payload type used to identify this codec.

Constructor Summary

Constructors

Constructor	Description
RTCRtpCodecParameters(int payloadType, MediaType mediaType, String codecName, int clockRate, int channels, Map<String,String> parameters)	Creates an instance of RTCRtpCodecParameters with the specified media codec parameters.

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

payloadType

public final int payloadType

The RTP payload type used to identify this codec.

mediaType

public final MediaType mediaType

The media type of the codec. Equivalent to the MIME top-level type.

codecName

public final String codecName

Used to identify the codec. Equivalent to the MIME subtype.

clockRate

public final int clockRate

The codec clock rate expressed in Hertz.

channels

public final int channels

When present, indicates the number of audio channels (mono=1, stereo=2).

parameters

public final Map<String,String> parameters

The "format specific parameters" field from the "a=fmtp" line in the SDP corresponding to the codec, if one exists. For an RTCRtpSender, these parameters come from the remote description, and for an RTCRtpReceiver, they come from the local description.

Constructor Detail

RTCRtpCodecParameters

public RTCRtpCodecParameters(int payloadType,
                             MediaType mediaType,
                             String codecName,
                             int clockRate,
                             int channels,
                             Map<String,String> parameters)

Creates an instance of RTCRtpCodecParameters with the specified media codec parameters.

Parameters:

payloadType - The RTP payload type used to identify the codec.

mediaType - The media type of the codec.

codecName - The codec name. Equivalent to the MIME subtype.

clockRate - The codec clock rate expressed in Hertz.

channels - The number of audio channels. Unused for video codecs.

parameters - The "a=fmtp" parameters in the SDP.

Method Detail

toString

public String toString()

Overrides:

toString in class Object