Visual Encoder MetaData File

Child elements of VisualEncoderMetaDataFile root element

XML elements

Attributes

Content

Number of occurrences

Description

Verbose/VB
Concise/CS

Immediate

EMPTY

0/1

Syntax that the driver uses to generate this XML file. By default, the driver uses the verbose syntax.

Count/C

Immediate

ReadOnly

PCDATA

0/1

Number of MetaData occurrences in this file.

MetaData/MD

 

Elements

Any

One metadata.

Child elements of MetaData element

XML elements

Attributes

Content

Number of occurrences

Description

Index/IX

ReadOnly

PCDATA

1

The unique index of the MetaData.

TimeStamp/TS

ReadOnly

PCDATA

0/1

Local time counter value at begin of data buffer recording time.

Dispose/D

WriteOnly

Immediate

EMPTY

0/1

Remove the MetaData entry and re-cycle the corresponding data buffer.

File/F

ReadOnly

PCDATA

0/1

The name of the buffer/data file. The file is located in the data sub-directory.

Size/S

ReadOnly

PCDATA

0/1

The size of the corresponding data.

VideoPresent/VP
VideoAbsent/VA

ReadOnly

EMPTY

0/1

The presence status of the video signal on the corresponding video input.

IDRSlice/IDR
PSlice/PS
SequenceParameterSet/SPS
PictureParameterSet/PPS

ReadOnly

EMPTY

0/1

The type of H.264 data.

OverflowSize/OS

ReadOnly

PCDATA

0/1

The amount of bytes that could not be put into the buffer because the amount of data produced by the hardware exceeded the buffer size. When not 0, it indicates the amount of dropped data.

XML File Examples

<root>/visual/source*/encoder/metadata.xml – Read operation – Verbose mode – No metadata

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE VisualEncoderMetaDataFile SYSTEM "metadata.dtd">
<VisualEncoderMetaDataFile version="1.0">
    <Verbose Immediate="true"/>
    <Count ReadOnly="true" Immediate="true">0</Count>
</VisualEncoderMetaDataFile>

<root>/visual/source*/encoder/metadata.xml – Read operation – Verbose mode

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE VisualEncoderMetaDataFile SYSTEM "metadata.dtd">
<VisualEncoderMetaDataFile version="1.0">
    <Verbose/>
    <Count>2</Count>
    <MetaData>
        <Index>0</Index>
        <TimeStamp>3213212</TimeStamp>
        <File>15</File>
        <Size>123121</Size>
        <VideoPresent/>
        <IDRSlice/>
        <OverflowSize>0</OverflowSize>
    </MetaData>
    <MetaData>
        <Index>1</Index>
        <TimeStamp>45665687</TimeStamp>
        <File>16</File>
        <Size>32027</Size>
        <VideoPresent/>
        <PSlice/>
        <OverflowSize>0</OverflowSize>
    </MetaData>
</VisualEncoderMetaDataFile>

<root>/visual/source*/encoder/metadata.xml – Write operation – Dispose of the buffer of Index 0

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE VisualEncoderMetaDataFile SYSTEM "metadata.dtd">
<VisualEncoderMetaDataFile version="1.0">
    <MetaData>
        <Index>0</Index>
        <Dispose/>
    </MetaData>
</VisualEncoderMetaDataFile>