javax.media.format
Class H261Format

java.lang.Object
  |
  +--javax.media.Format
        |
        +--javax.media.format.VideoFormat
              |
              +--javax.media.format.H261Format

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class H261Format

extends VideoFormat

Describes H.261 compressed video data.

Since:

JMF 2.0

See Also:

Serialized Form

Field Summary

protected int

stillImageTransmission Used to indicate whether or not still image transmission is used.

Fields inherited from class javax.media.format.VideoFormat

CINEPAK, frameRate, H261, H261_RTP, H263, H263_1998_RTP, H263_RTP, INDEO32, INDEO41, INDEO50, IRGB, JPEG, JPEG_RTP, maxDataLength, MJPEGA, MJPEGB, MJPG, MPEG, MPEG_RTP, RGB, RLE, RPZA, size, SMC, YUV

Fields inherited from class javax.media.Format

byteArray, clz, dataType, encoding, FALSE, formatArray, intArray, NOT_SPECIFIED, shortArray, TRUE

Constructor Summary

H261Format()
Constructs an H261Format object with default parameters.

H261Format(java.awt.Dimension size, int maxDataLength, java.lang.Class dataType, float frameRate, int stillImageTransmission)
Constructs an H261Format object with the specified parameters.

Method Summary

java.lang.Object	clone() Creates a clone of this H261Format.
protected void	copy(Format f) Copies the attributes from the specified Format into this H261Format.
boolean	equals(java.lang.Object format) Compares the specified Format with this H261Format.
int	getStillImageTransmission() Gets the still image transmission setting for this Format.
Format	intersects(Format format) Finds the attributes shared by two matching Format objects.
boolean	matches(Format format) Checks whether or not the specified Format matches this H261Format.
java.lang.String	toString() Gets a String representation of the attributes of this H261Format.

Methods inherited from class javax.media.format.VideoFormat

getFrameRate, getMaxDataLength, getSize, relax

Methods inherited from class javax.media.Format

getDataType, getEncoding, isSameEncoding, isSameEncoding

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

stillImageTransmission

protected int stillImageTransmission

Used to indicate whether or not still image transmission is used. Can be set to NOT_SPECIFIED, TRUE, or FALSE.

Constructor Detail

H261Format

public H261Format()

Constructs an H261Format object with default parameters.

H261Format

public H261Format(java.awt.Dimension size,
                  int maxDataLength,
                  java.lang.Class dataType,
                  float frameRate,
                  int stillImageTransmission)

Constructs an H261Format object with the specified parameters.

Parameters:

size - A Dimension that specifies the frame size.

maxDataLength - The maximum size of the compressed data array.

dataType - The class type of the data.

frameRate - The frame rate of the video.

stillImageTransmission - Specifies whether or not H.261 still image transmission is used (H.261 Annex D).

Method Detail

getStillImageTransmission

public int getStillImageTransmission()

Gets the still image transmission setting for this Format.

Returns:

An integer that indicates whether or not still image transmission is used: TRUE, FALSE, or NOT_SPECIFIED.

clone

public java.lang.Object clone()

Creates a clone of this H261Format.

Overrides:

clone in class VideoFormat

Returns:

A clone of this H261Format.

copy

protected void copy(Format f)

Copies the attributes from the specified Format into this H261Format.

Overrides:

copy in class VideoFormat

Parameters:

f - The Format to copy the attributes from.

toString

public java.lang.String toString()

Gets a String representation of the attributes of this H261Format. For example: "H261, 352x240, ...".

Overrides:

toString in class VideoFormat

Returns:

A String that describes the format attributes.

equals

public boolean equals(java.lang.Object format)

Compares the specified Format with this H261Format. Returns true only if the specified Format is a H261Format object and all of its attributes are identical to the attributes in this H261Format.

Overrides:

equals in class VideoFormat

Parameters:

format - The Format to compare.

Returns:

true if the specified Format is the same as this one.

matches

public boolean matches(Format format)

Checks whether or not the specified Format matches this H261Format. Matches only compares the attributes that are defined in the specified Format, unspecified attributes are ignored.

The two Format objects do not have to be of the same class to match. For example, if "A" are "B" are being compared, a match is possible if "A" is derived from "B" or "B" is derived from "A". (The compared attributes must still match, or matches fails.)

Overrides:

matches in class VideoFormat

Parameters:

format - The Format to compare with this one.

Returns:

true if the specified Format matches this one, false if it does not.

intersects

public Format intersects(Format format)

Finds the attributes shared by two matching Format objects. If the specified Format does not match this one, the result is undefined.

Overrides:

intersects in class VideoFormat

Returns:

A Format object with its attributes set to those attributes common to both Format objects.

See Also:

matches(javax.media.Format)