Visual Source Configuration

Child elements of VisualSource 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.

VideoPresent/VP

ReadOnly

Immediate

Elements

0/1

Presence indication of a valid video signal on the corresponding video input.

VideoAbsent/VA

ReadOnly

Immediate

EMPTY

0/1

Presence indication of a valid video signal on the corresponding video input.

VideoStandard_PAL/PAL
VideoStandard_NTSC/NTSC
VideoStandard_CCIR/CCIR
VideoStandard_EIA/EIA

 

EMPTY

0/1

Video standard setting of the video decoder.

Contrast/C

Immediate

PCDATA

0/1

Luminance gain (contrast) control. Value range: [0..200]. Default value: 100.

Brightness/B

Immediate

PCDATA

0/1

Luminance offset (brightness) control. Value range: [-100..100]. Default value: 0.

Saturation/S

Immediate

PCDATA

0/1

Chrominance gain (saturation control). Value range: [0..200]. Default value: 100.

Caption0

Immediate

Elements

0/1

The first image caption. This element is absent if String is not defined or empty.

Caption1

Immediate

Elements

0/1

The second image caption. This element is absent if String is not defined or empty. (*)

Mask0

Immediate

Elements

0/1

The 1st privacy mask region. This element is absent if the mask is not defined, for example when W and H are both 0. (*)

Mask1

Immediate

Elements

0/1

The 2nd privacy mask region. This element is absent if the mask is not defined, for example when W and H are both 0.

Mask2

Immediate

Elements

0/1

The 3rd privacy mask region. This element is absent if the mask is not defined, for example when W and H are both 0.

Mask3

Immediate

Elements

0/1

The 4th privacy mask region. This element is absent if the mask is not defined, for example when W and H are both 0.

(*) The caption is inserted on both the formatted and compressed streams. The caption text layer is above the privacy mask layer. A privacy mask doesn't mask the caption text. The text is left justified. The character set is the 7-bit US ASCII character set; non-printable characters are displayed as small rectangles. The multibytes UTF-8 characters are not allowed. The font is not configurable. The character cell size is 16 x 26. The character foreground is white. The character background is semi-transparent: the excursion of the video luminance is limited upwards.

Child elements of VideoPresent

XML elements

Attributes

Content

Number of occurrences

Description

DetectedVideoStandard_PAL/DS_PAL
DetectedVideoStandard_NTSC/DS_NTSC
DetectedVideoStandard_CCIR/DS_CCIR
DetectedVideoStandard_EIA/DS_EIA

ReadOnly

Immediate

EMPTY

0/1

The video standard of the video signal detected by the video decoder. This element is absent if VideoAbsent is present.

Child elements of Caption0, Caption1

XML elements

Attributes

Content

Number of occurrences

Description

String/STR

Immediate

PCDATA

0/1

The caption text string. Max string length: 47 characters. Setting an empty string disables the parent caption element.

TopLeft/TL
BottomLeft/BL
TopRight/TR
BottomRight/BR

Immediate

EMPTY

0/1

Pre-defined position of a text caption. There are 4 pre-defined positions. The default position is TopLeft.

With the pre-defined positions, a margin of 16 pixels is inserted between the image edges and the text.

X

Immediate

PCDATA

0/1

Customized X-coordinate of the top-left corner of the first character cell of the caption text. (*)

Y

Immediate

PCDATA

0/1

Customized Y-coordinate of the top-left corner of the first character cell of the caption text. (*)

(*) The coordinate origin (0, 0) is the top-left corner of the display. The X-coordinate range is [0..703]. The Y-coordinate range is [0..574]. Coordinates are positive integers expressed in pixels unit of the full resolution image.

Child elements of Mask0, Mask1, Mask2, Mask3

XML elements

Attributes

Content

Number of occurrences

Description

X

Immediate

PCDATA

1

X-coordinate of the top-left corner of the rectangular area. (*)

Y

Immediate

PCDATA

1

Y-coordinate of the top-left corner of the rectangular area. (*)

W

Immediate

PCDATA

1

Width of the rectangular area. (**)

H

Immediate

PCDATA

1

Height of the rectangular area. (**)

(*) The coordinate origin (0, 0) is the top-left corner of the display. The X-coordinate range is [0..703]. The Y-coordinate range is [0..574]. Coordinates are positive integers expressed in pixels unit of the full resolution image.

(**) Setting both W and H to 0 disables the parent mask element.

XML File Example

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE VisualSource SYSTEM "config.dtd">
<VisualSource version="1.0">
    <Verbose Immediate="true"/>
    <VideoPresent ReadOnly="true" Immediate="true">
        <DetectedVideoStandard_PAL ReadOnly="true" Immediate="true"/>
    </VideoPresent>
    <VideoStandard_PAL/>
    <Contrast Immediate="true">100</Contrast>
    <Brightness Immediate="true">0</Brightness>
    <Saturation Immediate="true">100</Saturation>
    <Caption0 Immediate="true">
        <String>Vid : 1</String>
        <TopLeft/>
    </Caption0>
    <Caption1 Immediate="true">
        <String>18-01-10 13:40:08</String>
        <BottomLeft/>
    </Caption1>
    <Mask0 Immediate="true">
        <X>25</X>
        <Y>50</Y>
        <W>75</W>
        <H>100</H>
    </Mask0>
    <Mask1 Immediate="true">
        <X>0</X>
        <Y>0</Y>
        <W>0</W>
        <H>0</H>
    </Mask1>
    <Mask2 Immediate="true">
        <X>0</X>
        <Y>0</Y>
        <W>0</W>
        <H>0</H>
    </Mask2>
    <Mask3 Immediate="true">
        <X>0</X>
        <Y>0</Y>
        <W>0</W>
        <H>0</H>
    </Mask3>
</VisualSource>