Frame (Jaffree 0.2 API)

java.lang.Object
- com.github.kokorin.jaffree.ffprobe.Frame

public class Frame
extends Object

Java class for frameType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="frameType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="tag" type="{http://www.ffmpeg.org/schema/ffprobe}tagType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="logs" type="{http://www.ffmpeg.org/schema/ffprobe}logsType" minOccurs="0"/>
         <element name="side_data_list" type="{http://www.ffmpeg.org/schema/ffprobe}frameSideDataListType" minOccurs="0"/>
       </sequence>
       <attribute name="media_type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="stream_index" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="key_frame" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="pts" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pts_time" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="pkt_pts" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pkt_pts_time" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="pkt_dts" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pkt_dts_time" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="best_effort_timestamp" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="best_effort_timestamp_time" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="pkt_duration" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pkt_duration_time" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="pkt_pos" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pkt_size" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="sample_fmt" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="nb_samples" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="channels" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="channel_layout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="width" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="height" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="pix_fmt" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="sample_aspect_ratio" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="pict_type" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="coded_picture_number" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="display_picture_number" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="interlaced_frame" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="top_field_first" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="repeat_pict" type="{http://www.w3.org/2001/XMLSchema}int" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Long`	`bestEffortTimestamp`
`protected Float`	`bestEffortTimestampTime`
`protected String`	`channelLayout`
`protected Integer`	`channels`
`protected Long`	`codedPictureNumber`
`protected Long`	`displayPictureNumber`
`protected Long`	`height`
`protected Integer`	`interlacedFrame`
`protected int`	`keyFrame`
`protected Logs`	`logs`
`protected String`	`mediaType`
`protected Long`	`nbSamples`
`protected String`	`pictType`
`protected String`	`pixFmt`
`protected Long`	`pktDts`
`protected Float`	`pktDtsTime`
`protected Long`	`pktDuration`
`protected Float`	`pktDurationTime`
`protected Long`	`pktPos`
`protected Long`	`pktPts`
`protected Float`	`pktPtsTime`
`protected Integer`	`pktSize`
`protected Long`	`pts`
`protected Float`	`ptsTime`
`protected Integer`	`repeatPict`
`protected String`	`sampleAspectRatio`
`protected String`	`sampleFmt`
`protected FrameSideDataList`	`sideDataList`
`protected Integer`	`streamIndex`
`protected List<Tag>`	`tag`
`protected Integer`	`topFieldFirst`
`protected Long`	`width`

Constructor Summary

Constructors
Constructor and Description

Frame()

Constructors
Constructor and Description
`Frame()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getBestEffortTimestamp()` Gets the value of the bestEffortTimestamp property.
`Float`	`getBestEffortTimestampTime()` Gets the value of the bestEffortTimestampTime property.
`String`	`getChannelLayout()` Gets the value of the channelLayout property.
`Integer`	`getChannels()` Gets the value of the channels property.
`Long`	`getCodedPictureNumber()` Gets the value of the codedPictureNumber property.
`Long`	`getDisplayPictureNumber()` Gets the value of the displayPictureNumber property.
`Long`	`getHeight()` Gets the value of the height property.
`Integer`	`getInterlacedFrame()` Gets the value of the interlacedFrame property.
`int`	`getKeyFrame()` Gets the value of the keyFrame property.
`Logs`	`getLogs()` Gets the value of the logs property.
`String`	`getMediaType()` Gets the value of the mediaType property.
`Long`	`getNbSamples()` Gets the value of the nbSamples property.
`String`	`getPictType()` Gets the value of the pictType property.
`String`	`getPixFmt()` Gets the value of the pixFmt property.
`Long`	`getPktDts()` Gets the value of the pktDts property.
`Float`	`getPktDtsTime()` Gets the value of the pktDtsTime property.
`Long`	`getPktDuration()` Gets the value of the pktDuration property.
`Float`	`getPktDurationTime()` Gets the value of the pktDurationTime property.
`Long`	`getPktPos()` Gets the value of the pktPos property.
`Long`	`getPktPts()` Gets the value of the pktPts property.
`Float`	`getPktPtsTime()` Gets the value of the pktPtsTime property.
`Integer`	`getPktSize()` Gets the value of the pktSize property.
`Long`	`getPts()` Gets the value of the pts property.
`Float`	`getPtsTime()` Gets the value of the ptsTime property.
`Integer`	`getRepeatPict()` Gets the value of the repeatPict property.
`String`	`getSampleAspectRatio()` Gets the value of the sampleAspectRatio property.
`String`	`getSampleFmt()` Gets the value of the sampleFmt property.
`FrameSideDataList`	`getSideDataList()` Gets the value of the sideDataList property.
`Integer`	`getStreamIndex()` Gets the value of the streamIndex property.
`List<Tag>`	`getTag()` Gets the value of the tag property.
`Integer`	`getTopFieldFirst()` Gets the value of the topFieldFirst property.
`Long`	`getWidth()` Gets the value of the width property.
`void`	`setBestEffortTimestamp(Long value)` Sets the value of the bestEffortTimestamp property.
`void`	`setBestEffortTimestampTime(Float value)` Sets the value of the bestEffortTimestampTime property.
`void`	`setChannelLayout(String value)` Sets the value of the channelLayout property.
`void`	`setChannels(Integer value)` Sets the value of the channels property.
`void`	`setCodedPictureNumber(Long value)` Sets the value of the codedPictureNumber property.
`void`	`setDisplayPictureNumber(Long value)` Sets the value of the displayPictureNumber property.
`void`	`setHeight(Long value)` Sets the value of the height property.
`void`	`setInterlacedFrame(Integer value)` Sets the value of the interlacedFrame property.
`void`	`setKeyFrame(int value)` Sets the value of the keyFrame property.
`void`	`setLogs(Logs value)` Sets the value of the logs property.
`void`	`setMediaType(String value)` Sets the value of the mediaType property.
`void`	`setNbSamples(Long value)` Sets the value of the nbSamples property.
`void`	`setPictType(String value)` Sets the value of the pictType property.
`void`	`setPixFmt(String value)` Sets the value of the pixFmt property.
`void`	`setPktDts(Long value)` Sets the value of the pktDts property.
`void`	`setPktDtsTime(Float value)` Sets the value of the pktDtsTime property.
`void`	`setPktDuration(Long value)` Sets the value of the pktDuration property.
`void`	`setPktDurationTime(Float value)` Sets the value of the pktDurationTime property.
`void`	`setPktPos(Long value)` Sets the value of the pktPos property.
`void`	`setPktPts(Long value)` Sets the value of the pktPts property.
`void`	`setPktPtsTime(Float value)` Sets the value of the pktPtsTime property.
`void`	`setPktSize(Integer value)` Sets the value of the pktSize property.
`void`	`setPts(Long value)` Sets the value of the pts property.
`void`	`setPtsTime(Float value)` Sets the value of the ptsTime property.
`void`	`setRepeatPict(Integer value)` Sets the value of the repeatPict property.
`void`	`setSampleAspectRatio(String value)` Sets the value of the sampleAspectRatio property.
`void`	`setSampleFmt(String value)` Sets the value of the sampleFmt property.
`void`	`setSideDataList(FrameSideDataList value)` Sets the value of the sideDataList property.
`void`	`setStreamIndex(Integer value)` Sets the value of the streamIndex property.
`void`	`setTopFieldFirst(Integer value)` Sets the value of the topFieldFirst property.
`void`	`setWidth(Long value)` Sets the value of the width property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tag
```
protected List<Tag> tag
```
  - logs
```
protected Logs logs
```
  - sideDataList
```
protected FrameSideDataList sideDataList
```
  - mediaType
```
protected String mediaType
```
  - streamIndex
```
protected Integer streamIndex
```
  - keyFrame
```
protected int keyFrame
```
  - pts
```
protected Long pts
```
  - ptsTime
```
protected Float ptsTime
```
  - pktPts
```
protected Long pktPts
```
  - pktPtsTime
```
protected Float pktPtsTime
```
  - pktDts
```
protected Long pktDts
```
  - pktDtsTime
```
protected Float pktDtsTime
```
  - bestEffortTimestamp
```
protected Long bestEffortTimestamp
```
  - bestEffortTimestampTime
```
protected Float bestEffortTimestampTime
```
  - pktDuration
```
protected Long pktDuration
```
  - pktDurationTime
```
protected Float pktDurationTime
```
  - pktPos
```
protected Long pktPos
```
  - pktSize
```
protected Integer pktSize
```
  - sampleFmt
```
protected String sampleFmt
```
  - nbSamples
```
protected Long nbSamples
```
  - channels
```
protected Integer channels
```
  - channelLayout
```
protected String channelLayout
```
  - width
```
protected Long width
```
  - height
```
protected Long height
```
  - pixFmt
```
protected String pixFmt
```
  - sampleAspectRatio
```
protected String sampleAspectRatio
```
  - pictType
```
protected String pictType
```
  - codedPictureNumber
```
protected Long codedPictureNumber
```
  - displayPictureNumber
```
protected Long displayPictureNumber
```
  - interlacedFrame
```
protected Integer interlacedFrame
```
  - topFieldFirst
```
protected Integer topFieldFirst
```
  - repeatPict
```
protected Integer repeatPict
```
- Constructor Detail
  - Frame
```
public Frame()
```
- Method Detail
  - getTag
```
public List<Tag> getTag()
```
    Gets the value of the tag property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the tag property.
    For example, to add a new item, do as follows:
```
    getTag().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Tag
  - getLogs
```
public Logs getLogs()
```
    Gets the value of the logs property.
    
    Returns:
    
    possible object is Logs
  - setLogs
```
public void setLogs(Logs value)
```
    Sets the value of the logs property.
    
    Parameters:
    
    value - allowed object is Logs
  - getSideDataList
```
public FrameSideDataList getSideDataList()
```
    Gets the value of the sideDataList property.
    
    Returns:
    
    possible object is FrameSideDataList
  - setSideDataList
```
public void setSideDataList(FrameSideDataList value)
```
    Sets the value of the sideDataList property.
    
    Parameters:
    
    value - allowed object is FrameSideDataList
  - getMediaType
```
public String getMediaType()
```
    Gets the value of the mediaType property.
    
    Returns:
    
    possible object is String
  - setMediaType
```
public void setMediaType(String value)
```
    Sets the value of the mediaType property.
    
    Parameters:
    
    value - allowed object is String
  - getStreamIndex
```
public Integer getStreamIndex()
```
    Gets the value of the streamIndex property.
    
    Returns:
    
    possible object is Integer
  - setStreamIndex
```
public void setStreamIndex(Integer value)
```
    Sets the value of the streamIndex property.
    
    Parameters:
    
    value - allowed object is Integer
  - getKeyFrame
```
public int getKeyFrame()
```
    Gets the value of the keyFrame property.
  - setKeyFrame
```
public void setKeyFrame(int value)
```
    Sets the value of the keyFrame property.
  - getPts
```
public Long getPts()
```
    Gets the value of the pts property.
    
    Returns:
    
    possible object is Long
  - setPts
```
public void setPts(Long value)
```
    Sets the value of the pts property.
    
    Parameters:
    
    value - allowed object is Long
  - getPtsTime
```
public Float getPtsTime()
```
    Gets the value of the ptsTime property.
    
    Returns:
    
    possible object is Float
  - setPtsTime
```
public void setPtsTime(Float value)
```
    Sets the value of the ptsTime property.
    
    Parameters:
    
    value - allowed object is Float
  - getPktPts
```
public Long getPktPts()
```
    Gets the value of the pktPts property.
    
    Returns:
    
    possible object is Long
  - setPktPts
```
public void setPktPts(Long value)
```
    Sets the value of the pktPts property.
    
    Parameters:
    
    value - allowed object is Long
  - getPktPtsTime
```
public Float getPktPtsTime()
```
    Gets the value of the pktPtsTime property.
    
    Returns:
    
    possible object is Float
  - setPktPtsTime
```
public void setPktPtsTime(Float value)
```
    Sets the value of the pktPtsTime property.
    
    Parameters:
    
    value - allowed object is Float
  - getPktDts
```
public Long getPktDts()
```
    Gets the value of the pktDts property.
    
    Returns:
    
    possible object is Long
  - setPktDts
```
public void setPktDts(Long value)
```
    Sets the value of the pktDts property.
    
    Parameters:
    
    value - allowed object is Long
  - getPktDtsTime
```
public Float getPktDtsTime()
```
    Gets the value of the pktDtsTime property.
    
    Returns:
    
    possible object is Float
  - setPktDtsTime
```
public void setPktDtsTime(Float value)
```
    Sets the value of the pktDtsTime property.
    
    Parameters:
    
    value - allowed object is Float
  - getBestEffortTimestamp
```
public Long getBestEffortTimestamp()
```
    Gets the value of the bestEffortTimestamp property.
    
    Returns:
    
    possible object is Long
  - setBestEffortTimestamp
```
public void setBestEffortTimestamp(Long value)
```
    Sets the value of the bestEffortTimestamp property.
    
    Parameters:
    
    value - allowed object is Long
  - getBestEffortTimestampTime
```
public Float getBestEffortTimestampTime()
```
    Gets the value of the bestEffortTimestampTime property.
    
    Returns:
    
    possible object is Float
  - setBestEffortTimestampTime
```
public void setBestEffortTimestampTime(Float value)
```
    Sets the value of the bestEffortTimestampTime property.
    
    Parameters:
    
    value - allowed object is Float
  - getPktDuration
```
public Long getPktDuration()
```
    Gets the value of the pktDuration property.
    
    Returns:
    
    possible object is Long
  - setPktDuration
```
public void setPktDuration(Long value)
```
    Sets the value of the pktDuration property.
    
    Parameters:
    
    value - allowed object is Long
  - getPktDurationTime
```
public Float getPktDurationTime()
```
    Gets the value of the pktDurationTime property.
    
    Returns:
    
    possible object is Float
  - setPktDurationTime
```
public void setPktDurationTime(Float value)
```
    Sets the value of the pktDurationTime property.
    
    Parameters:
    
    value - allowed object is Float
  - getPktPos
```
public Long getPktPos()
```
    Gets the value of the pktPos property.
    
    Returns:
    
    possible object is Long
  - setPktPos
```
public void setPktPos(Long value)
```
    Sets the value of the pktPos property.
    
    Parameters:
    
    value - allowed object is Long
  - getPktSize
```
public Integer getPktSize()
```
    Gets the value of the pktSize property.
    
    Returns:
    
    possible object is Integer
  - setPktSize
```
public void setPktSize(Integer value)
```
    Sets the value of the pktSize property.
    
    Parameters:
    
    value - allowed object is Integer
  - getSampleFmt
```
public String getSampleFmt()
```
    Gets the value of the sampleFmt property.
    
    Returns:
    
    possible object is String
  - setSampleFmt
```
public void setSampleFmt(String value)
```
    Sets the value of the sampleFmt property.
    
    Parameters:
    
    value - allowed object is String
  - getNbSamples
```
public Long getNbSamples()
```
    Gets the value of the nbSamples property.
    
    Returns:
    
    possible object is Long
  - setNbSamples
```
public void setNbSamples(Long value)
```
    Sets the value of the nbSamples property.
    
    Parameters:
    
    value - allowed object is Long
  - getChannels
```
public Integer getChannels()
```
    Gets the value of the channels property.
    
    Returns:
    
    possible object is Integer
  - setChannels
```
public void setChannels(Integer value)
```
    Sets the value of the channels property.
    
    Parameters:
    
    value - allowed object is Integer
  - getChannelLayout
```
public String getChannelLayout()
```
    Gets the value of the channelLayout property.
    
    Returns:
    
    possible object is String
  - setChannelLayout
```
public void setChannelLayout(String value)
```
    Sets the value of the channelLayout property.
    
    Parameters:
    
    value - allowed object is String
  - getWidth
```
public Long getWidth()
```
    Gets the value of the width property.
    
    Returns:
    
    possible object is Long
  - setWidth
```
public void setWidth(Long value)
```
    Sets the value of the width property.
    
    Parameters:
    
    value - allowed object is Long
  - getHeight
```
public Long getHeight()
```
    Gets the value of the height property.
    
    Returns:
    
    possible object is Long
  - setHeight
```
public void setHeight(Long value)
```
    Sets the value of the height property.
    
    Parameters:
    
    value - allowed object is Long
  - getPixFmt
```
public String getPixFmt()
```
    Gets the value of the pixFmt property.
    
    Returns:
    
    possible object is String
  - setPixFmt
```
public void setPixFmt(String value)
```
    Sets the value of the pixFmt property.
    
    Parameters:
    
    value - allowed object is String
  - getSampleAspectRatio
```
public String getSampleAspectRatio()
```
    Gets the value of the sampleAspectRatio property.
    
    Returns:
    
    possible object is String
  - setSampleAspectRatio
```
public void setSampleAspectRatio(String value)
```
    Sets the value of the sampleAspectRatio property.
    
    Parameters:
    
    value - allowed object is String
  - getPictType
```
public String getPictType()
```
    Gets the value of the pictType property.
    
    Returns:
    
    possible object is String
  - setPictType
```
public void setPictType(String value)
```
    Sets the value of the pictType property.
    
    Parameters:
    
    value - allowed object is String
  - getCodedPictureNumber
```
public Long getCodedPictureNumber()
```
    Gets the value of the codedPictureNumber property.
    
    Returns:
    
    possible object is Long
  - setCodedPictureNumber
```
public void setCodedPictureNumber(Long value)
```
    Sets the value of the codedPictureNumber property.
    
    Parameters:
    
    value - allowed object is Long
  - getDisplayPictureNumber
```
public Long getDisplayPictureNumber()
```
    Gets the value of the displayPictureNumber property.
    
    Returns:
    
    possible object is Long
  - setDisplayPictureNumber
```
public void setDisplayPictureNumber(Long value)
```
    Sets the value of the displayPictureNumber property.
    
    Parameters:
    
    value - allowed object is Long
  - getInterlacedFrame
```
public Integer getInterlacedFrame()
```
    Gets the value of the interlacedFrame property.
    
    Returns:
    
    possible object is Integer
  - setInterlacedFrame
```
public void setInterlacedFrame(Integer value)
```
    Sets the value of the interlacedFrame property.
    
    Parameters:
    
    value - allowed object is Integer
  - getTopFieldFirst
```
public Integer getTopFieldFirst()
```
    Gets the value of the topFieldFirst property.
    
    Returns:
    
    possible object is Integer
  - setTopFieldFirst
```
public void setTopFieldFirst(Integer value)
```
    Sets the value of the topFieldFirst property.
    
    Parameters:
    
    value - allowed object is Integer
  - getRepeatPict
```
public Integer getRepeatPict()
```
    Gets the value of the repeatPict property.
    
    Returns:
    
    possible object is Integer
  - setRepeatPict
```
public void setRepeatPict(Integer value)
```
    Sets the value of the repeatPict property.
    
    Parameters:
    
    value - allowed object is Integer

Class Frame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tag

logs

sideDataList

mediaType

streamIndex

keyFrame

pts

ptsTime

pktPts

pktPtsTime

pktDts

pktDtsTime

bestEffortTimestamp

bestEffortTimestampTime

pktDuration

pktDurationTime

pktPos

pktSize

sampleFmt

nbSamples

channels

channelLayout

width

height

pixFmt

sampleAspectRatio

pictType

codedPictureNumber

displayPictureNumber

interlacedFrame

topFieldFirst

repeatPict

Constructor Detail

Frame

Method Detail

getTag

getLogs

setLogs

getSideDataList

setSideDataList

getMediaType

setMediaType

getStreamIndex

setStreamIndex

getKeyFrame

setKeyFrame

getPts

setPts

getPtsTime

setPtsTime

getPktPts

setPktPts

getPktPtsTime

setPktPtsTime

getPktDts

setPktDts

getPktDtsTime

setPktDtsTime

getBestEffortTimestamp

setBestEffortTimestamp

getBestEffortTimestampTime

setBestEffortTimestampTime

getPktDuration

setPktDuration

getPktDurationTime

setPktDurationTime

getPktPos

setPktPos

getPktSize

setPktSize

getSampleFmt

setSampleFmt

getNbSamples

setNbSamples