In neomedia:

- Uses double for clockRate for both AudioMediaFormat and VideoMediaFormat as it's done in MediaFormatFactory.
- Fixes a few javadocs.
cusax-fix
Lyubomir Marinov 17 years ago
parent a7077acd05
commit 7bfec39c21

@ -79,9 +79,8 @@ public String toString()
* @return a <tt>MediaDirection</tt> value corresponding to the specified
* <tt>mediaDirectionName</tt>.
*
* @throws a <tt>java.lang.IllegalArgumentException</tt> in case
* <tt>mediaDirectionName</tt> is not a valid or currently supported media
* direction.
* @throws IllegalArgumentException in case <tt>mediaDirectionName</tt> is
* not a valid or currently supported media direction.
*/
public static MediaDirection parseString(String mediaDirectionName)
throws IllegalArgumentException

@ -23,13 +23,13 @@ public interface MediaService
* Returns the default <tt>MediaDevice</tt> for the specified media
* <tt>type</tt>. In most cases users
*
* @param type a <tt>MediaType</tt> instance indicating the kind of device
* @param mediaType a <tt>MediaType</tt> value indicating the kind of device
* that we are trying to obtain.
*
* @return the currently default <tt>MediaDevice</tt> for the specified
* <tt>MediaType</tt>, or <tt>null</tt> if no such device exists.
*/
public MediaDevice getDefaultDevice(MediaType type);
public MediaDevice getDefaultDevice(MediaType mediaType);
/**
* Returns a list containing all devices known to this service
@ -48,9 +48,10 @@ public interface MediaService
* <tt>MediaDevice</tt> for both capture and playback of media exchanged
* via the specified <tt>MediaConnector</tt>.
*
* @param connector the connector that the stream should use for sending and receiving
* media.
* @param device
* @param connector the connector that the stream should use for sending and
* receiving media.
* @param device the device to be used for both capture and playback of
* media changed via the specified <tt>MediaConnector</tt>
*
* @return the newly created <tt>MediaStream</tt>.
*/

@ -61,8 +61,8 @@ public String toString()
* @return a <tt>MediaType</tt> value corresponding to the specified
* <tt>mediaTypeName</tt>.
*
* @throws a <tt>java.lang.IllegalArgumentException</tt> in case
* <tt>mediaTypeName</tt> is not a valid or currently supported media type.
* @throws IllegalArgumentException in case <tt>mediaTypeName</tt> is not a
* valid or currently supported media type.
*/
public static MediaType parseString(String mediaTypeName)
throws IllegalArgumentException

@ -42,9 +42,9 @@ public interface MediaFormat
/**
* Returns the clock rate associated with this <tt>MediaFormat</tt>.
*
* @return The clock rate associated with this format..
* @return The clock rate associated with this format.
*/
public float getClockRate();
public double getClockRate();
/**
* Determines whether this <tt>MediaFormat</tt> is equal to
@ -59,14 +59,13 @@ public interface MediaFormat
public boolean equals(Object mediaFormat);
/**
* Returns a <tt>Map</tt> containing parameters specific to this
* particular <tt>MediaFormat</tt>. The parameters returned here are meant
* for use in SIP/SDP or XMPP session descriptions where they get
* transported through the "fmtp:" attribute or <parameter/> tag
* respectively.
* Returns a <tt>Map</tt> containing parameters specific to this particular
* <tt>MediaFormat</tt>. The parameters returned here are meant for use in
* SIP/SDP or XMPP session descriptions where they get transported through
* the "fmtp:" attribute or <parameter/> tag respectively.
*
* @return Returns a <tt>Map</tt> containing parameters specific to this
* particular <tt>MediaFormat</tt>.
* @return a <tt>Map</tt> containing parameters specific to this particular
* <tt>MediaFormat</tt>.
*/
public Map<String, String> getFormatParameters();

@ -46,8 +46,8 @@ public AudioMediaFormat createAudioMediaFormat(
*
* @param encoding the encoding of the format to create.
* @param clockRate the rate in Hz of the audio format
* @param channels the number of availabe channels (1 for mono,
* 2 for stereo)
* @param channels the number of available channels (1 for mono, 2 for
* stereo)
*
* @return a newly created <tt>AudioMediaFormat</tt> with the specified
* parameters.
@ -62,8 +62,8 @@ public AudioMediaFormat createAudioMediaFormat(
*
* @param encoding the encoding of the format to create.
* @param clockRate the rate in Hz of the audio format
* @param formatParams any codec specific params that have being received
* via SIP/SDP or XMPP/Jingle.
* @param formatParams any codec specific params that have been received via
* SIP/SDP or XMPP/Jingle.
*
* @return a newly created <tt>AudioMediaFormat</tt> with the specified
* parameters.
@ -106,7 +106,7 @@ public AudioMediaFormat createAudioMediaFormat(
* and <tt>frameRate</tt>.
*
* @param encoding the encoding of the format to create.
* @param clockRate the the frame rate
* @param clockRate the clock (i.e. frame) rate
* @return a newly created <tt>AudioMediaFormat</tt> with the specified
* parameters.
*/

Loading…
Cancel
Save