ISO/IEC 29341-4-14:2011

Information technology — UPnP Device Architecture — Part 4-14: Audio Video Device Control Protocol — Level 2 — Scheduled Recording Service

ISO/IEC 29341-4-14:2011(E) The ScheduledRecording service is a UPnP service that allows control points to schedule the recording of content. Generally, this content is broadcast content, but this specification does not limit itself to broadcast content. This service type enables the following functions: - Create a recordSchedule. - Browse a list of recordSchedule instances stored by the ScheduledRecording service. - Delete a recordSchedule. - Browse a list of recordTask instances, stored by the ScheduledRecording service. The ScheduledRecording service may create zero or more recordTask instances for each recordSchedule. A recordTask represents a discrete recording operation of a recordSchedule. - Enable or disable individual recordTask instances. - Enable or disable a recordSchedule. - Receive notifications indicating change of recordSchedule or recordTask list. This device specification is compliant with the Universal Plug and Play Device Architecture version 1.0. It defines a device type referred to herein as ScheduledRecording. This International Standard replaces ISO/IEC 29341-4-14, first edition, published in 2008, and constitutes a technical revision.

Technologies de l'information — Architecture de dispositif UPnP — Partie 4-14: Protocole de contrôle de dispositif audio-vidéo — Niveau 2 — Service d'enregistrement programmé

General Information

• Status: Published
• Publication Date: 14-Sep-2011
• ICS: 35.200 - Interface and interconnection equipment
• Technical Committee: ISO/IEC JTC 1 - Information technology
• Drafting Committee: ISO/IEC JTC 1 - Information technology
• Current Stage: 9060 - Close of review
• Start Date: 04-Jun-2027

Relations

• Revises: ISO/IEC 29341-4-14:2008 - Information technology — UPnP Device Architecture — Part 4-14: Audio Video Device Control Protocol - Level 2 - Scheduled Recording Service
• Effective Date: 07-Aug-2010

Standards Content (Sample)

ISO/IEC 29341-4-14
Edition 2.0 2011-09
INTERNATIONAL
STANDARD

colour
inside

Information technology – UPnP device architecture –
Part 4-14: Audio Video Device Control Protocol – Level 2 – Scheduled Recording
Service


ISO/IEC 29341-4-14:2011(E)

---------------------- Page: 1 ----------------------
THIS PUBLICATION IS COPYRIGHT PROTECTED
Copyright © 2011 ISO/IEC, Geneva, Switzerland


All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form
or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from
either IEC or IEC's member National Committee in the country of the requester.
If you have any questions about ISO/IEC copyright or have an enquiry about obtaining additional rights to this
publication, please contact the address below or your local IEC member National Committee for further information.

IEC Central Office
3, rue de Varembé
CH-1211 Geneva 20
Switzerland
Email: [e-mail]
Web: www.iec.ch

About the IEC
The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes
International Standards for all electrical, electronic and related technologies.

About IEC publications
The technical content of IEC publications is kept under constant review by the IEC. Please make sure that you have the
latest edition, a corrigenda or an amendment might have been published.
 Catalogue of IEC publications: www.iec.ch/searchpub
The IEC on-line Catalogue enables you to search by a variety of criteria (reference number, text, technical committee,…).
It also gives information on projects, withdrawn and replaced publications.
 IEC Just Published: www.iec.ch/online_news/justpub
Stay up to date on all new IEC publications. Just Published details twice a month all new publications released. Available
on-line and also by email.
 Electropedia: www.electropedia.org
The world's leading online dictionary of electronic and electrical terms containing more than 20 000 terms and definitions
in English and French, with equivalent terms in additional languages. Also known as the International Electrotechnical
Vocabulary online.
 Customer Service Centre: www.iec.ch/webstore/custserv
If you wish to give us your feedback on this publication or need further assistance, please visit the Customer Service
Centre FAQ or contact us:
Email: [e-mail]
Tel.: [phone]
Fax: [phone]

---------------------- Page: 2 ----------------------
ISO/IEC 29341-4-14
Edition 2.0 2011-09
INTERNATIONAL
STANDARD

colour
inside

Information technology – UPnP device architecture –
Part 4-14: Audio Video Device Control Protocol – Level 2 – Scheduled Recording
Service


INTERNATIONAL
ELECTROTECHNICAL
COMMISSION
PRICE CODE
XF
ICS 35.200 ISBN 978-2-88912-683-5

---------------------- Page: 3 ----------------------
29341-4-14 29341-4-14 XXXX: © IEC:2010 © ISO/IEC:2011(E)© ISO/IEC:2011(E) – 1 –
CONTENTS

1  Overview and Scope . 8
1.1  Introduction . 8
1.2  Notation . 9
1.2.1  Data Types . 9
1.2.2  Strings Embedded in Other Strings . 9
1.2.3  Extended Backus-Naur Form . 10
1.3  Derived Data Types . 10
1.3.1  Comma Separated Value (CSV) Lists . 11
1.4  Management of XML Namespaces in Standardized DCPs . 12
1.4.1  Namespace Prefix Requirements . 14
1.4.2  Namespace Names, Namespace Versioning and Schema Versioning . 15
1.4.3  Namespace Usage Examples . 17
1.5  Vendor-defined Extensions . 18
1.5.1  Vendor-defined Action Names . 18
1.5.2  Vendor-defined State Variable Names . 18
1.5.3  Vendor-defined XML Elements and attributes . 18
1.5.4  Vendor-defined Property Names . 18
1.6  References . 18
2  Service Modeling Definitions . 22
2.1  ServiceType . 22
2.2  Terms and Abbreviations . 22
2.2.1  Abbreviati ons . 22
2.2.2  Terms . 22
2.3  ScheduledRecording Service Architecture . 29
2.3.1  recordSchedule . 29
2.3.2  recordTask . 30
2.4  State Variables . 31
2.4.1  State Variable Overview . 32
2.4.2  SortCapabilities . 32
2.4.3  SortLevelCapability . 32
2.4.4  StateUpdateID . 33
2.4.5  LastChange . 33
2.4.6  A_ARG_TYPE_PropertyList . 36
2.4.7  A_ARG_TYPE_DataTypeID . 36
2.4.8  A_ARG_TYPE_ObjectID . 36
2.4.9  A_ARG_TYPE_ObjectIDList . 36
2.4.10  A_ARG_TYPE_PropertyInfo . 36
2.4.11  A_ARG_TYPE_Index . 37
2.4.12  A_ARG_TYPE_Count . 37
2.4.13  A_ARG_TYPE_SortCriteria . 37
2.4.14  A_ARG_TYPE_RecordSchedule . 37
2.4.15  A_ARG_TYPE_RecordTask . 37
2.4.16  A_ARG_TYPE_RecordScheduleParts . 38
2.5  Eventing and Moderation . 39
2.6  Actions . 40

---------------------- Page: 4 ----------------------
XXXX: © IEC:2010 – 2 – 29341-4-14 29341-4-14 © ISO/IEC:2011(E)© ISO/IEC:2011(E)
2.6.1  GetSortCapabilities() . 40
2.6.2  GetPropertyList() . 41
2.6.3  GetAllowedValues() . 42
2.6.4  GetStateUpdateID() . 44
2.6.5  BrowseRecordSchedules() . 44
2.6.6  BrowseRecordTasks() . 49
2.6.7  CreateRecordSchedule() . 50
2.6.8  DeleteRecordSchedule() . 53
2.6.9  GetRecordSchedule() . 54
2.6.10  EnableRecordSchedule() . 55
2.6.11  DisableRecordSchedule() . 56
2.6.12  DeleteRecordTask() . 57
2.6.13  GetRecordTask() . 58
2.6.14  EnableRecordTask() . 59
2.6.15  DisableRecordTask() . 60
2.6.16  ResetRecordTask() . 61
2.6.17  GetRecordScheduleConflicts() . 62
2.6.18  GetRecordTaskConflicts() . 63
2.6.19  Common Error Codes . 64
2.7  State Diagram of recordTask . 66
2.7.1  A Full-Featured State Diagram . 66
2.7.2  A Minimal-Implementation State Diagram . 71
2.7.3  recordTask State Example . 74
2.8  ScheduledRecording Service Priority Model . 75
2.8.1  Introduction of the ScheduledRecording Service Priority Model . 75
2.8.2  Ordered Priority within Each Priority Level . 76
2.8.3  Setting the Initial Priority Level of a recordSchedule . 77
2.8.4  Sorting recordSchedule Instances Based on their Current Priority
Settings . 79
2.9  Theory of Operation . 79
2.9.1  Introduction . 79
2.9.2  Checking the Capabilities of a ScheduledRecording Servic e . 79
2.9.3  Adding a Scheduled Recording Entry to the List . 90
2.9.4  Deleting a recordSchedule . 102
2.9.5  Browsing recordSchedule and recordTask instances . 103
2.9.6  Rating System . 108
2.9.7  Conflict Detection and Resolution . 109
3  XML Service Description . 110
4  Test . 118
Annex A (normative) srs XML Document . 119
A.1  A_ARG_TYPE_RecordSchedule AVDT XML Document . 119
A.2  A_ARG_TYPE_RecordTask AVDT XML Document . 120
A.3  A_ARG_TYPE_RecordScheduleParts AVDT XML Document . 120
Annex B (normative) AV Working Committee Extended Properties . 122
B.1  Base Propert ies . 122
B.1.1  @id . 122
B.1.2  title . 122
B.1.3  class . 123
B.1.4  additionalStatusInfo . 123

---------------------- Page: 5 ----------------------
29341-4-14 29341-4-14 XXXX: © IEC:2010 © ISO/IEC:2011(E)© ISO/IEC:2011(E) – 3 –
B.1.5  cdsReference . 124
B.2  Priority Prop erties . 125
B.2.1  priority . 125
B.2.2  desiredPriority . 126
B.2.3  desiredPriority@type . 128
B.3  Output Control Properties . 128
B.3.1  recordDestination . 128
B.3.2  desiredRecordQuality . 130
B.4  Content Identification Related Properties . 133
B.4.1  scheduledCDSObjectID . 133
B.4.2  scheduledChannelID . 134
B.4.3  scheduledStartDateTime . 136
B.4.4  scheduledDuration . 137
B.4.5  scheduledProgramCode . 137
B.5  Matching Content Criteria Properties . 138
B.5.1  matchingName . 138
B.5.2  matchingID . 139
B.6  Matching Qualifying Criteria Properties . 140
B.6.1  matchingChannelID . 140
B.6.2  matchingStartDateTimeRange . 142
B.6.3  matchingDurationRange . 142
B.6.4  matchingRatingLimit . 143
B.6.5  matchingEpisodeType . 145
B.7  Content Control Properties . 146
B.7.1  totalDesiredRecordTasks . 146
B.7.2  scheduledStartDateTimeAdjust . 146
B.7.3  scheduledDurationAdjust . 147
B.7.4  activePeriod . 147
B.7.5  durationLimit . 148
B.7.6  channelMigration . 149
B.7.7  timeMigration . 149
B.7.8  allowDuplicates . 150
B.8  Storage Related Properties . 150
B.8.1  persistedRecordings . 150
B.9  Schedule State Properties . 152
B.9.1  scheduleState . 152
B.9.2  abnormalTasksExist . 153
B.10  Statistics Properties . 153
B.10.1  currentRecordTaskCount . 154
B.10.2  totalCreatedRecordTasks . 154
B.10.3  totalCompletedRecordTasks . 154
B.11  Task General Properties . 155
B.11.1  recordScheduleID . 155
B.11.2  recordedCDSObjectID . 155
B.12  Task Content Identification Properties . 156
B.12.1  taskCDSObjectID . 156
B.12.2  taskChannelID . 157
B.12.3  taskStartDateTime . 158
B.12.4  taskDuration . 158

---------------------- Page: 6 ----------------------
XXXX: © IEC:2010 – 4 – 29341-4-14 29341-4-14 © ISO/IEC:2011(E)© ISO/IEC:2011(E)
B.12.5  taskProgramCode . 159
B.12.6  recordQuality . 159
B.13  Task Matched Content Criteria Properti es . 161
B.13.1  matchedName . 161
B.13.2  matchedID . 162
B.14  Task Matched Qualifying Criteria Properties . 163
B.14.1  matchedRating . 163
B.14.2  matchedRating@type . 163
B.14.3  matchedEpisodeType . 163
B.15  Task Matched Content Control Properties . 164
B.15.1  taskStartDateTimeAdjust . 164
B.15.2  taskDurationAdjust . 164
B.15.3  taskDurationLimit . 164
B.15.4  taskDurationLimit@effect . 165
B.15.5  taskChannelMigration . 165
B.15.6  taskTimeMigration . 165
B.16  Task State Properties . 166
B.16.1  taskState . 166
B.17  ContentDirectory Service Imported Proper ties . 175
Annex C (normative) AV Working Committee Class Defi nitions . 180
C.1  Class Hierar chy . 180
C.1.1  Relationships between Classes and Properties . 181
C.1.2  recordScheduleParts Properti es . 182
C.1.3  recordSchedule Properties . 186
C.1.4  recordTask Properties . 190
C.2  Class Definitions . 192
C.3  object Base Class . 193
C.3.1  object.recordSchedule Class . 194
C.3.2  object.recordTask Class . 207
Annex D (normative) EBNF Syntax Definitions . 209
D.1  Priority Syntax . 209
D.2  Date&time Syntax . 209
D.3  Class Name Syntax . 209
Annex E (informative) ScheduledRecording Service Relationship to ContentDirectory
Service . 211
Annex F (informative) ScheduledRecording Service Relationship to EPG . 212
Annex G (informative) AVDT Examples . 213
G.1  A_ARG_TYPE_RecordSchedule AVDT Example . 213
G.2  A_ARG_TYPE_RecordTask AVDT Exam ple . 228
G.3  A_ARG_TYPE_RecordScheduleParts AVDT Example . 244

Figure 1 — Creating a new recordSchedule . 29
Figure 2 — Capability check. . 30
Figure 3 — Browse recordSchedule. . 30
Figure 4 — Delete a recordSchedule . 30
Figure 5 — A Full-Featured State Diagram . 67
Figure 6 — A Minimal-Implementation State Diagram . 72

---------------------- Page: 7 ----------------------
29341-4-14 29341-4-14 XXXX: © IEC:2010 © ISO/IEC:2011(E)© ISO/IEC:2011(E) – 5 –
Figure 7 — Class hierarchy for the ScheduledRecording service. . 181

Table 1-1 — EBNF Operators . 10
Table 1-2 — CSV Examples . 11
Table 1-3 — Namespace Definitions . 13
Table 1-4 — Schema-related Information . 14
Table 1-5 — Default Namespaces for the AV Specifications . 15
Table 2-1 — Abbr eviations . 22
Table 2-1 — Properties in XML . 25
Table 2-2 — State Variables . 32
Table 2-3 — allowedValueList for the DataTypeID argument . 32
Table 2-4 — Allowed Elements in Element . 34
Table 2-5 — Eventing and Moderation . 39
Table 2-6 — Actions . 40
Table 2-7 — Arguments for GetSortCapabilities() . 40
Table 2-8 — Error Codes for GetSortCapabilities() . 41
Table 2-9 — Arguments for GetPropertyList() . 41
Table 2-10 — Error Codes for GetPropertyList() . 42
Table 2-11 — Arguments for GetAllowedValues() . 42
Table 2-12 — Error Codes for GetAllowedValues() . 43
Table 2-13 — Arguments for GetStateUpdateID() . 44
Table 2-14 — Error Codes for GetStateUpdateID() . 44
Table 2-15 — Arguments for BrowseRecordSchedules() . 44
Table 2-16 — Error Codes for BrowseRecordSchedules() . 48
Table 2-17 — Arguments for BrowseRecordTasks() . 49
Table 2-18 — Error Codes for BrowseRecordTasks() . 50
Table 2-19 — Arguments for CreateRecordSchedule() . 51
Table 2-20 — Error Codes for CreateRecordSchedule() . 53
Table 2-21 — Arguments for DeleteRecordSchedule() . 54
Table 2-22 — Error Codes for DeleteRecordSchedule() . 54
Table 2-23 — Arguments for GetRecordSchedule() . 54
Table 2-24 — Error Codes for GetRecordSchedule() . 55
Table 2-25 — Arguments for EnableRecordSchedule() . 56
Table 2-26 — Error Codes for EnableRecordSchedule() . 56
Table 2-27 — Arguments for DisableRecordSchedule() . 57
Table 2-28 — Error Codes for DisableRecordSchedule() . 57
Table 2-29 — Arguments for DeleteRecordTask() . 57
Table 2-30 — Error Codes for DeleteRecordTask() . 58
Table 2-31 — Arguments for GetRecordTask() . 58
Table 2-32 — Error Codes for GetRecordTask() . 59
Table 2-33 — Arguments for EnableRecordTask() . 59
Table 2-34 — Error Codes for EnableRecordTask() . 60
Table 2-35 — Arguments for DisableRecordTask() . 60

---------------------- Page: 8 ----------------------
XXXX: © IEC:2010 – 6 – 29341-4-14 29341-4-14 © ISO/IEC:2011(E)© ISO/IEC:2011(E)
Table 2-36 — Error Codes for DisableRecordTask() . 61
Table 2-37 — Arguments for ResetRecordTask() . 61
Table 2-38 — Error Codes for ResetRecordTas
...