Skip to content

Latest commit

 

History

History
119 lines (98 loc) · 5.27 KB

nf-spatialaudiometadata-ispatialaudiometadatareader-readnextitem.md

File metadata and controls

119 lines (98 loc) · 5.27 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:spatialaudiometadata.ISpatialAudioMetadataReader.ReadNextItem
ISpatialAudioMetadataReader::ReadNextItem (spatialaudiometadata.h)
Gets the number of commands and the sample offset for the metadata item being read.
ISpatialAudioMetadataReader interface [Core Audio]
ReadNextItem method
ISpatialAudioMetadataReader.ReadNextItem
ISpatialAudioMetadataReader::ReadNextItem
ReadNextItem
ReadNextItem method [Core Audio]
ReadNextItem method [Core Audio]
ISpatialAudioMetadataReader interface
coreaudio.ispatialaudiometadatareader_readnextitem
spatialaudiometadata/ISpatialAudioMetadataReader::ReadNextItem
coreaudio\ispatialaudiometadatareader_readnextitem.htm
CoreAudio
AC1D5FD6-EFF1-410F-95C7-B13EACBED5D1
12/05/2018
ISpatialAudioMetadataReader interface [Core Audio],ReadNextItem method, ISpatialAudioMetadataReader.ReadNextItem, ISpatialAudioMetadataReader::ReadNextItem, ReadNextItem, ReadNextItem method [Core Audio], ReadNextItem method [Core Audio],ISpatialAudioMetadataReader interface, coreaudio.ispatialaudiometadatareader_readnextitem, spatialaudiometadata/ISpatialAudioMetadataReader::ReadNextItem
spatialaudiometadata.h
Windows
Windows
19H1
ISpatialAudioMetadataReader::ReadNextItem
spatialaudiometadata/ISpatialAudioMetadataReader::ReadNextItem
c++
APIRef
kbSyntax
COM
SpatialAudioMetadata.h
ISpatialAudioMetadataReader.ReadNextItem

ISpatialAudioMetadataReader::ReadNextItem

-description

Gets the number of commands and the sample offset for the metadata item being read.

-parameters

-param commandCount [out]

Receives the number of command/value pairs in the metadata item being read.

-param frameOffset [out]

Gets the frame offset associated with the metadata item being read.

-returns

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
SPTLAUD_MD_CLNT_E_NO_ITEMS_OPEN
The ISpatialAudioMetadataItems has not been opened for reading with a call to Open or the object has been closed for writing with a call to Close.
SPTLAUD_MD_CLNT_E_NO_MORE_ITEMS
There are no more metadata items in the frame range specified in the call to ReadItemCountInFrames.
E_INVALIDARG
One of the provided pointers is not valid.

-remarks

Before calling ReadNextItem, you must open the ISpatialAudioMetadataReader for reading by calling Open after the object is created and after Close has been called. You must also call ReadItemCountInFrames before calling ReadNextItem.

The ISpatialAudioMetadataReader keeps an internal pointer to the current position within the total range of frames contained by the ISpatialAudioMetadataItems with which the reader is associated. Each call to this method causes the pointer to be advanced by the number of frames specified in the readFrameCount parameter.

The process for reading commands and the associated values is recursive. After each call to ReadItemCountInFrames, call ReadNextItem to get the number of commands in the next item. After every call to ReadNextItem, call ReadNextItemCommand to read each command for the item. Repeat this process until the entire frame range of the ISpatialAudioMetadataItems has been read.

-see-also

ISpatialAudioMetadataReader