Description:
Manages the OSD multiple region template. The system uses a set of predefined
regions in each template to control the display of multiple OSD images, OSD crawl,
and OSD text.
The template sets specific parameters for each OSD region. Images are set to
a specific position and size. Image position and size cannot be modified. Crawls are
also set to specific parameters, however, those parameters may be overridden when the
crawl is started. TEXT region parameters may also be overridden when the text is started.
Each region within a template must be activated by the appropriate OSD commands.
Images are loaded using the "OSD n l 'imagename'" command (where 'n' is the region number).
The image can then be displayed using the "OSD n D" command (no additional parameters required).
CRAWLs can be started by using the "OSD n CRAWL" command, or the "OSD n CRAWL [custom parameters]"
command to override the template defaults.
TEXT can be started by using the "OSD n TEXT" command, or the "OSD n TEXT [custom parameters]"
command to override the template defaults.
Please see the OSD command API for details on use of the OSD command to activate OSD images.
The template parameters are dependent on the display resolution.
When a template is changed, all currently loaded and displayed OSD images, CRAWL and TEXT are
cleared and removed from the display.
The default template is OFF. This template allows only one OSD region to be used,
and does not support OSD CRAWL or TEXT.
The template setting is saved in the DCMD CONFIGURATION file.
Note: OSD based DECODECLOSEDCAPTION modes and OSD cannot be used at the same time.
If DECODECLOSEDCAPTION is set to an OSD based mode , then the OSD and OST
command options will not be activated. The API will return an error message
"OSD based closed caption is active, cannot run OSD functions" in this case.
The terse form of the error message is 568.
Form:
Command Handler: DCMD
OSDTEMPLATE|OST|OT <ARGUMENT>
Argument List:
Terse Verbose Description
0 OFF No template is active, standard single region OSD functionality
1 720LSD 720hx1280w Resolution "L" template with 2 images, crawl and text
with standard definition video content.
2 1080LSD 1080hx1920w Resolution "L" template with 2 images, crawl and text
with standard definition video content.
3 NTSCL 480hx720w Resolution "L" template with 2 images, crawl and text
4 PALL 525hx720w Resolution "L" template with 2 images, crawl and text
5 720LHD 720hx1280w Resolution "L" template with 2 images, crawl and text
with high definition video content. (VIDEO may 'tear' during playback)
6 1080LHD 1080hx1920w Resolution "L" template with 2 images, crawl and text
with high definition video content. (VIDEO may 'tear' during playback)
7 720JSD 720hx1280w Resolution "J" template with 2 images, crawl and text
with standard definition video content.
8 1080JSD 1080hx1920w Resolution "J" template with 2 images, crawl and text
with standard definition video content.
9 NTSCJ 480hx720w Resolution "J" template with 2 images, crawl and text
10 PALJ 525hx720w Resolution "J" template with 2 images, crawl and text
11 720JHD 720hx1280w Resolution "J" template with 2 images, crawl and text
with high definition video content. (VIDEO may 'tear' during playback)
12 1080JHD 1080hx1920w Resolution "J" template with 2 images, crawl and text
with high definition video content. (VIDEO may 'tear' during playback)
13 720FULL 720hx1280w Resolution full screen template with 1 image, crawl and text
14 1080FULL 1080hx1920w Resolution full screen template with 1 image, crawl and text
15 NTSCFULL 480hx720w Resolution full screen template with 1 image, crawl and text
16 PALFULL 576hx720w Resolution full screen template with 1 image, crawl and text
Response:
OSDTEMPLATE RESPONSE
Verbose- "OK\r\n" to acknowledge receipt of command, or
"ERROR- [Description]\r\n" if error, ending command
Terse- "0\r\n" to acknowledge receipt of command, or
"[NON-ZERO NUMERIC VALUE]\r\n" if error, ending command
"\r\n" concludes modify responses (empty line)
Examples:
Verbose command to set up template for 1080I L pattern with crawl.
*.DCMD OST 1080LSD <enter>
Response is: OK\r\n
Verbose command to set up template OFF
*.DCMD OST OFF <enter>
Response is: OK\r\n
Terse command to set up template OFF
*.DCMD OT 0 <enter>
Response is: OK\r\n
Verbose command to display the current template settings
(Terse response is identical to verbose response)
*.DCMD OST <enter>
OK
OSDTEMPLATE = 1080LSD
OSD REGION 0 IMAGE Template Name: Left Panel Origin: (0,0) Size= 590W x 885H
OSD REGION 1 IMAGE Template Name: Bottom Panel Origin: (0,885) Size= 1920W x 195H
OSD REGION 2 CRAWL Template Name: Crawl Origin (0,1000) Size= 1920W x 60H
Crawl File: /media/hd0/osd/crawl.txt Speed: 2 Direction: 2 Repeat: ON
Font File: /usr/local/lib/Vera.ttf Scale: 48 Font Color: ff00aa00 Crawl Background Color: ff000080
OSD REGION 3 TEXT Template Name: Date & Time Type: TIMEDATE Origin (0,10) Size= 590W x 90H
Refresh: 1000 Justification: CENTER
Font File: /usr/local/lib/Vera.ttf Scale: 36 Font Color: ff00aa00 Crawl Background Color: ff000080
Notes: