Package org.apache.poi.hslf.record
Class ExMediaAtom
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.ExMediaAtom
An atom record that specifies information about external audio or video data.
- Author:
- Yegor Kozlov
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
A bit that specifies whether the audio or video data is repeated continuously during playback.static final int
A bit that specifies whether the audio data is recorded narration for the slide show.static final int
A bit that specifies whether the audio or video data is rewound after playing. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructs a brand new link related atom record.protected
ExMediaAtom
(byte[] source, int start, int len) Constructs the link related atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptionboolean
getFlag
(int bit) int
getMask()
A bit mask specifying options for displaying headers and footersint
A 4-byte unsigned integer that specifies an ID for an external object.long
Gets the record type.void
setFlag
(int bit, boolean value) void
setMask
(int mask) A bit mask specifying options for displaying videovoid
setObjectId
(int id) A 4-byte unsigned integer that specifies an ID for an external object.toString()
void
writeOut
(OutputStream out) Write the contents of the record back, so it can be written to diskMethods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtom
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Field Details
-
fLoop
public static final int fLoopA bit that specifies whether the audio or video data is repeated continuously during playback.- See Also:
-
fRewind
public static final int fRewindA bit that specifies whether the audio or video data is rewound after playing.- See Also:
-
fNarration
public static final int fNarrationA bit that specifies whether the audio data is recorded narration for the slide show. It MUST be FALSE if this ExMediaAtom record is contained by an ExVideoContainer record.- See Also:
-
-
Constructor Details
-
ExMediaAtom
protected ExMediaAtom()Constructs a brand new link related atom record. -
ExMediaAtom
protected ExMediaAtom(byte[] source, int start, int len) Constructs the link related atom record from its source data.- Parameters:
source
- the source data as a byte array.start
- the start offset into the byte array.len
- the length of the slice in the byte array.
-
-
Method Details
-
getRecordType
public long getRecordType()Gets the record type.- Specified by:
getRecordType
in classRecord
- Returns:
- the record type.
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOut
in classRecord
- Parameters:
out
- the output stream to write to.- Throws:
IOException
- if an error occurs.
-
getObjectId
public int getObjectId()A 4-byte unsigned integer that specifies an ID for an external object.- Returns:
- A 4-byte unsigned integer that specifies an ID for an external object.
-
setObjectId
public void setObjectId(int id) A 4-byte unsigned integer that specifies an ID for an external object.- Parameters:
id
- A 4-byte unsigned integer that specifies an ID for an external object.
-
getMask
public int getMask()A bit mask specifying options for displaying headers and footers- Returns:
- A bit mask specifying options for displaying headers and footers
-
setMask
public void setMask(int mask) A bit mask specifying options for displaying video- Parameters:
mask
- A bit mask specifying options for displaying video
-
getFlag
public boolean getFlag(int bit) - Parameters:
bit
- the bit to check- Returns:
- whether the specified flag is set
-
setFlag
public void setFlag(int bit, boolean value) - Parameters:
bit
- the bit to setvalue
- whether the specified bit is set
-
toString
-