AudioFile.ReadPacketData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
ReadPacketData(Boolean, Int64, Int32, Byte[], Int32, Int32, AudioFileError)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, int nPackets, byte[] buffer, int offset, int count, out AudioToolbox.AudioFileError error);member this.ReadPacketData : bool * int64 * int * byte[] * int * int * AudioFileError -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
The number of packets to read.
- buffer
- Byte[]
The output buffer where packets are written.
- offset
- Int32
The offset in the output buffer where to start writing packets to.
- count
- Int32
The size of the output buffer (in bytes).
- error
- AudioFileError
Success if successful, or an error code otherwise.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, Byte[], Int32, Int32, AudioFileError)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, ref int nPackets, byte[] buffer, int offset, ref int count, out AudioToolbox.AudioFileError error);member this.ReadPacketData : bool * int64 * int * byte[] * int * int * AudioFileError -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
On input the number of packets to read, upon return the number of packets actually read.
- buffer
- Byte[]
The output buffer where packets are written.
- offset
- Int32
The offset in the output buffer where to start writing packets to.
- count
- Int32
On input the size of the output buffer (in bytes), upon return the actual number of bytes read.
- error
- AudioFileError
Success if successful, or an error code otherwise.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, IntPtr, Int32, AudioFileError, AudioStreamPacketDescription[])
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, ref int nPackets, IntPtr buffer, ref int count, out AudioToolbox.AudioFileError error, AudioToolbox.AudioStreamPacketDescription[] descriptions);member this.ReadPacketData : bool * int64 * int * nativeint * int * AudioFileError * AudioToolbox.AudioStreamPacketDescription[] -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
On input the number of packets to read, upon return the number of packets actually read.
- buffer
-
IntPtr
nativeint
The output buffer where packets are written.
- count
- Int32
On input the size of the output buffer (in bytes), upon return the actual number of bytes read.
- error
- AudioFileError
Success if successful, or an error code otherwise.
- descriptions
- AudioStreamPacketDescription[]
An array of packet descriptions describing the returned packets.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, Byte[], Int32, Int32)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, ref int nPackets, byte[] buffer, int offset, ref int count);member this.ReadPacketData : bool * int64 * int * byte[] * int * int -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
On input the number of packets to read, upon return the number of packets actually read.
- buffer
- Byte[]
The output buffer where packets are written.
- offset
- Int32
The offset in the output buffer where to start writing packets to.
- count
- Int32
On input the size of the output buffer (in bytes), upon return the actual number of bytes read.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, IntPtr, Int32, AudioFileError)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, ref int nPackets, IntPtr buffer, ref int count, out AudioToolbox.AudioFileError error);member this.ReadPacketData : bool * int64 * int * nativeint * int * AudioFileError -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
On input the number of packets to read, upon return the number of packets actually read.
- buffer
-
IntPtr
nativeint
The output buffer where packets are written.
- count
- Int32
On input the size of the output buffer (in bytes), upon return the actual number of bytes read.
- error
- AudioFileError
Success if successful, or an error code otherwise.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, IntPtr, Int32)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, ref int nPackets, IntPtr buffer, ref int count);member this.ReadPacketData : bool * int64 * int * nativeint * int -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
On input the number of packets to read, upon return the number of packets actually read.
- buffer
-
IntPtr
nativeint
The output buffer where packets are written.
- count
- Int32
On input the size of the output buffer (in bytes), upon return the actual number of bytes read.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Int64, Int32, Byte[], AudioFileError)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(long inStartingPacket, int nPackets, byte[] buffer, out AudioToolbox.AudioFileError error);member this.ReadPacketData : int64 * int * byte[] * AudioFileError -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
The number of packets to read.
- buffer
- Byte[]
The output buffer where packets are written.
- error
- AudioFileError
Success if successful, or an error code otherwise.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Int64, Int32, Byte[])
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(long inStartingPacket, int nPackets, byte[] buffer);member this.ReadPacketData : int64 * int * byte[] -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
The number of packets to read.
- buffer
- Byte[]
The output buffer where packets are written.
Returns
Array of packet descriptors for the packets that were read.
Applies to
ReadPacketData(Boolean, Int64, Int32, Byte[], Int32, Int32)
Reads packets of audio data from an audio file.
public AudioToolbox.AudioStreamPacketDescription[]? ReadPacketData(bool useCache, long inStartingPacket, int nPackets, byte[] buffer, int offset, int count);member this.ReadPacketData : bool * int64 * int * byte[] * int * int -> AudioToolbox.AudioStreamPacketDescription[]Parameters
- useCache
- Boolean
If the data should be cached.
- inStartingPacket
- Int64
The index of the first packet to read.
- nPackets
- Int32
The number of packets to read.
- buffer
- Byte[]
The output buffer where packets are written.
- offset
- Int32
The offset in the output buffer where to start writing packets to.
- count
- Int32
The size of the output buffer (in bytes).
Returns
Array of packet descriptors for the packets that were read.