Package org.apache.poi.hslf.record

Class SoundData

java.lang.Object

org.apache.poi.hslf.record.Record

org.apache.poi.hslf.record.RecordAtom

org.apache.poi.hslf.record.SoundData

All Implemented Interfaces:

GenericRecord

public final class SoundData
extends RecordAtom

Storage for embedded sounds.

Field Summary

Fields inherited from class org.apache.poi.hslf.record.Record

LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SoundData()	Constructs a new empty sound container.
protected	SoundData(byte[] source, int start, int len)	Constructs the link related atom record from its source data.

Method Summary

Modifier and Type	Method	Description
byte[]	getData()	Returns the sound data.
Map<String,Supplier<?>>	getGenericProperties()
static int	getMaxRecordLength()
long	getRecordType()	Gets the record type.
static void	setMaxRecordLength(int length)
void	writeOut(OutputStream out)	Write the contents of the record back, so it can be written to disk.

Methods inherited from class org.apache.poi.hslf.record.RecordAtom

getChildRecords, isAnAtom

Methods inherited from class org.apache.poi.hslf.record.Record

buildRecordAtOffset, createRecordForType, findChildRecords, getGenericChildren, getGenericRecordType, writeLittleEndian, writeLittleEndian

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundData

protected SoundData()

Constructs a new empty sound container.

SoundData

protected SoundData(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 Detail

setMaxRecordLength

public static void setMaxRecordLength(int length)

Parameters:

length - the max record length allowed for SoundData

getMaxRecordLength

public static int getMaxRecordLength()

Returns:

the max record length allowed for SoundData

getData

public byte[] getData()

Returns the sound data.

Returns:

the sound data

getRecordType

public long getRecordType()

Gets the record type.

Specified by:

getRecordType in class Record

Returns:

the record type.

writeOut

public void writeOut(OutputStream out)
              throws IOException

Write the contents of the record back, so it can be written to disk.

Specified by:

writeOut in class Record

Parameters:

out - the output stream to write to.

Throws:

IOException - if an error occurs.

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()