programRecord Element

Article
09/23/2009

Defines a recording request being made through the Windows Media Center click-to-record feature.

Syntax

  <programRecord
    prepadding="
  seconds
  "
    postpadding="seconds"
    allowAlternateAirings="{true | false}"
    allowAlternateServices="{true | false}"
    programDuration="minutes"
    firstRunOnly="{true | false}"
    daysOfWeek="bitflags"
    isRecurring="{true | false}"
    keepUntil="int"
    quality="int"
>
</programRecord>

Attributes

prepadding

Optional. Specifies the pre-padding time, in seconds, with respect to the start time. To begin recording before the start time, specify a negative value. To begin recording after the start time, specify a positive value. The default value is 0.

postpadding

Optional. Specifies the post-padding time, in seconds, with respect to the end time. To stop recording before the end time, specify a negative value. To stop recording after the end time, specify a positive value. The default value is 0.

allowAlternateAirings

Optional. Indicates how Windows Media Center should respond when it cannot find the specified airing of a program.

A value of "true" indicates that Windows Media Center can schedule the recording at an alternate time. A series will target a specific time for the first item that is found chronologically in the Electronic Program Guide (EPG).

A value of "false" indicates that if Windows Media Center cannot find the program within the specified time period, it should fail the request and inform the user. The default value is "false".

allowAlternateServices

Optional. Indicates how Windows Media Center should respond when it cannot find the specified airing of a program on a particular broadcast service. A value of "true" indicates that Windows Media Center can look for the same program on a different broadcast service. A value of "false" indicates that if Windows Media Center cannot find the program on the specified broadcast service, it should fail the request. The default value is "false".

programDuration

Optional. Specifies the duration of the program, in minutes. This attribute is used only if the document does not specify any program elements, and results in a manual recording. This attribute must specify a positive, non-zero number to create a manual recording.

firstRunOnly

Optional. Indicates whether to allow recording of TV programs that are marked as reruns in the program guide. A value of "true" prevents recording of reruns, and "false" allows it. The default value is "false".

daysOfWeek

Optional. Specifies an array of seven bit flags, expressed as a decimal value, indicating the days of the week that a program can be recorded for manual and generic "keyword" requests. Bit 0 is set to indicate Sunday, bit 1 Monday, and so on. The default value is 127 (every day).

isRecurring

Optional. Indicates whether the request is for a series of recordings, or just a one-time recording. A value of "true" indicates a recurring (series) recording, and "false" indicates a one-time recording. The default value is "false".

keepUntil

Optional. Specifies how long to keep the recorded files. The following values are possible (if no value is specified, the computer's default value is used):

-3: Latest recordings

-2: Keep until I watch

-1: Keep until space needed

0: Keep until I delete

Note Only the EventSchedule.CreateScheduleRequest method can correctly interpret these features of the input XML file. The deprecated ClickToRecord.Submit method for managed code, the MediaCenter.ScheduleRecording method for hosted HTML, and invoking the click-to-record feature from the Windows shell cannot accept this XML and may simply ignore these features.

quality

Optional. Specifies the quality of recording. The following values are possible (if no value is specified, the computer's default value is used):

0: Fair

1: Good

2: Better

3: Best

Remarks

This element has three child elements: program, service, and airing. Each can occur more than once. These elements serve as search criteria to target a specific program, optionally airing on a particular service at a particular time.

If the isRecurring attribute is "true", the daysOfWeek attribute applies only to the first program in a series. Subsequent episodes are scheduled based on the built-in series scheduling logic of Windows Media Center, regardless of the daysOfWeek attribute.

Requirements

Platform: Windows XP Media Center Edition 2005 and later

See Also

programRecord Element

Additional resources