public class EssenceMultiAccess extends Object implements EssenceMultiAccess, Serializable
| Modifier and Type | Method and Description |
|---|---|
static EssenceMultiAccess |
castFromInterface(EssenceMultiAccess alien)
Cast a
EssenceMultiAccess
value from the generic interface to this implementation of
the interface. |
MultiResultItem[] |
readMultiSamples(MultiXferItem[] xferArray)
Reads multiple channels of data from an interleaved data stream.
|
MultiResultItem[] |
writeMultiSamples(MultiXferItem[] xferArray)
Writes multiple channels worth of sample data into the essence from
an array of items representing interleaved data streams in the natural order
for the codec.
|
public static final EssenceMultiAccess castFromInterface(EssenceMultiAccess alien) throws NullPointerException
Cast a EssenceMultiAccess
value from the generic interface to this implementation of
the interface. If the given value is not a native implementation, a copy will be
instanciated using get and set methods.
alien - A potentially alien implementation of an instance of the EssenceMultiAccess
interface.NullPointerException - Argument is null.public MultiResultItem[] readMultiSamples(MultiXferItem[] xferArray) throws NullPointerException, InvalidParameterException
EssenceMultiAccessReads multiple channels of data from an interleaved data stream.
The given input array contains items that define which channel of data
should be read. These items are modified by the operation by their data
buffers being filled with data from the essence according to the parameters
they specify. See MultiXferItem for more details.
The array returned contains details of how many bytes and samples were
transferred by the operation corresponding to each input item of the array
given as a parameter. See MultiResultItem for more details.
readMultiSamples in interface EssenceMultiAccessxferArray - Array of transfer items to read data into.NullPointerException - The given transfer array is null or one or more of
its elements is null.InvalidParameterException - One or more of the parameters defined
by an item of the given array is invalid.EssenceMultiAccess.readMultiSamples(tv.amwa.maj.union.MultiXferItem[])public MultiResultItem[] writeMultiSamples(MultiXferItem[] xferArray) throws NullPointerException, InvalidParameterException
EssenceMultiAccessWrites multiple channels worth of sample data into the essence from
an array of items representing interleaved data streams in the natural order
for the codec. See MultiXferItem for details of the fields of each
item.
The array returned contains details of how many bytes and samples were
transferred by the operation corresponding to each input item of the array
given as a parameter. See MultiResultItem for more details.
writeMultiSamples in interface EssenceMultiAccessxferArray - An array of transfer parameters. All fields of items in
this array must be set up before performing the transfer.NullPointerException - The given transfer array is null or one or more of
its elements is null.InvalidParameterException - One or more of the parameters defined
by an item of the given array is invalid.EssenceMultiAccess.writeMultiSamples(tv.amwa.maj.union.MultiXferItem[])(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.