SIST ETS 300 714 E1:2003

Terminal Equipment (TE); Application Programming Interface (API) for the manipulation of Multimedia and Hypermedia information objects

To specify an API above the Multimedia & Hypermedia Information (MHI) objects allowing their manipulation (eg by scripts): - activating/deactivating MHI object presentations (inc windowing & - requesting/getting back user interaction; (rendition); - uniform access to (logically stored or remote) MHI objects.

Terminalska oprema (TE) – Aplikacijski programski vmesnik za ravnanje z multimedijskimi in hipermedijskimi informacijskimi objekti

General Information

• Status: Published
• Publication Date: 30-Nov-2003
• ICS: 33.160.60 - Multimedia systems and teleconferencing equipment
• ICS: 35.180 - IT Terminal and other peripheral equipment
• Technical Committee: SS EIT - Technical Board for the electrotechnical, information technology and telecommunications fields
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Dec-2003
• Due Date: 01-Dec-2003
• Completion Date: 01-Dec-2003
• Ref Project: ETSI ETS 300 714 ed.1 (1997-05) - Terminal Equipment (TE); Application Programming Interface (API) for the manipulation of Multimedia and Hypermedia information objects

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ETS 300 714 E1:2003
01-december-2003
Terminalska oprema (TE) – Aplikacijski programski vmesnik za ravnanje z
multimedijskimi in hipermedijskimi informacijskimi objekti
Terminal Equipment (TE); Application Programming Interface (API) for the manipulation
of Multimedia and Hypermedia information objects
Ta slovenski standard je istoveten z: ETS 300 714 Edition 1
ICS:
33.160.60 9HþSUHGVWDYQLPXOWLPHGLMVNL Multimedia systems and
VLVWHPLLQRSUHPD]D teleconferencing equipment
WHOHNRQIHUHQFH
35.180 Terminalska in druga IT Terminal and other
periferna oprema IT peripheral equipment
SIST ETS 300 714 E1:2003 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ETS 300 714 E1:2003

---------------------- Page: 2 ----------------------

SIST ETS 300 714 E1:2003
EUROPEAN ETS 300 714
TELECOMMUNICATION May 1997
STANDARD
Source: ETSI TC-MTA Reference: DE/MTA-001045
formerly DE/TE-01045
ICS: 33.020
Key words: API, MHEG, multimedia
Terminal Equipment (TE);
Application Programming Interface (API) for the manipulation of
Multimedia and Hypermedia information objects
ETSI
European Telecommunications Standards Institute
ETSI Secretariat
Postal address: F-06921 Sophia Antipolis CEDEX - FRANCE
Office address: 650 Route des Lucioles - Sophia Antipolis - Valbonne - FRANCE
X.400: c=fr, a=atlas, p=etsi, s=secretariat - Internet: [e-mail]
Tel.: [phone] - Fax: [phone]
Copyright Notification: No part may be reproduced except as authorized by written permission. The copyright and the
foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 1997. All rights reserved.

---------------------- Page: 3 ----------------------

SIST ETS 300 714 E1:2003
Page 2
ETS 300 714: May 1997
Whilst every care has been taken in the preparation and publication of this document, errors in content,
typographical or otherwise, may occur. If you have comments concerning its accuracy, please write to
"ETSI Editing and Committee Support Dept." at the address shown on the title page.

---------------------- Page: 4 ----------------------

SIST ETS 300 714 E1:2003
Page 3
ETS 300 714: May 1997
Contents
Foreword .9
Introduction.9
1 Scope .11
2 Normative references.11
3 Definitions and abbreviations .12
3.1 Definitions .12
3.2 Abbreviations .15
4 Conformance.16
4.1 Implementation conformance .16
4.1.1 Conformance requirements.16
4.1.2 Conformance documentation.16
4.2 Application conformance .17
4.2.1 Strictly conforming application.17
4.2.2 Conforming application.17
4.3 Test methods.17
5 General description .17
5.1 Functional reference model of applications using MHEG.17
5.1.1 Reference model for multimedia applications .17
5.1.2 The MHEG API.22
5.2 Functional specification of the MHEG API.23
5.2.1 MHEG usage specifications .23
5.2.1.1 Definitions.23
5.2.1.2 MHEG objects .23
5.2.1.3 Mh-objects .24
5.2.1.4 Rt-objects .24
5.2.1.5 Channels.24
5.2.1.6 Interchanged MHEG objects .24
5.2.2 Description of MHEG-related services .25
6 API definition principles .26
6.1 Satisfaction of technical requirements on the MHEG API .26
6.2 Use of Interface Definition Language .26
6.2.1 Comprehensive introduction to IDL.26
6.2.2 The Interface Definition Language (IDL) .27
6.2.2.1 Objects .27
6.2.2.2 Requests.27
6.2.2.3 Types.28
6.2.2.4 Interfaces.28
6.2.2.5 Operations .28
6.2.2.6 Attributes.29
6.2.2.7 Subtyping versus inheritance.29
6.2.2.8 Subtyping.29
6.2.2.9 Inheritance.29
6.2.3 Principles for mapping IDL interfaces to API primitives .29
6.2.4 Fulfilment of technical requirements .30
6.3 Overview of the API definition and general principles.30
6.3.1 The MHEG API object model .30
7 Definition of the MHEG API.32
7.1 Mandatory primitives.32

---------------------- Page: 5 ----------------------

SIST ETS 300 714 E1:2003
Page 4
ETS 300 714: May 1997
7.1.1 MHEGEngine object . 32
7.1.1.1 initialiseEngine operation . 32
7.1.1.2 shutdownEngine operation. 32
7.1.1.3 IDL description . 32
7.1.2 NotificationManager object . 32
7.1.2.1 getReturnability operation . 32
7.1.2.2 getNotification operation . 33
7.1.2.3 IDL description . 33
7.1.3 EntityManager object . 33
7.1.3.1 getAvailableMhObjects operation . 33
7.1.3.2 getAvailableRtObjects operation. 34
7.1.3.3 getAvailableChannels operation . 34
7.1.3.4 releaseAlias operation. 34
7.1.3.5 IDL description . 35
7.1.4 Entity object . 35
7.1.4.1 setAlias operation. 35
7.1.4.2 getAlias operation . 35
7.1.4.3 IDL description . 36
7.1.5 MhObject object. 36
7.1.5.1 bind operation . 36
7.1.5.2 unbind operation . 36
7.1.5.3 prepare operation. 37
7.1.5.4 destroy operation . 37
7.1.5.5 getPreparationStatus operation . 38
7.1.5.6 getIdentifier operation . 38
7.1.5.7 kill operation. 38
7.1.5.8 IDL description . 39
7.1.6 MhAction object . 39
7.1.6.1 delay operation. 39
7.1.6.2 IDL description . 40
7.1.7 MhLink object. 40
7.1.7.1 abort operation. 40
7.1.7.2 IDL description . 40
7.1.8 MhModel object . 40
7.1.8.1 IDL description . 41
7.1.9 MhComponent object. 41
7.1.9.1 IDL description . 41
7.1.10 MhGenericContent object. 41
7.1.10.1 copy operation. 41
7.1.10.2 IDL description . 41
7.1.11 MhContent object. 42
7.1.11.1 setData operation. 42
7.1.11.2 getData operation. 42
7.1.11.3 IDL description . 43
7.1.12 MhMultiplexedContent object . 43
7.1.12.1 setMultiplex operation . 43
7.1.12.2 setDemultiplex operation . 44
7.1.12.3 IDL description . 44
7.1.13 MhComposite object. 44
7.1.13.1 IDL description . 45
7.1.14 MhScript object. 45
7.1.14.1 IDL description . 45
7.1.15 MhContainer object. 45
7.1.15.1 IDL description . 45
7.1.16 MhDescriptor object. 45
7.1.16.1 IDL description . 45
7.1.17 RtObjectOrSocket object. 45
7.1.17.1 setGlobalBehaviour operation. 45
7.1.17.2 getGlobalBehaviour operation. 46
7.1.17.3 run operation. 46
7.1.17.4 stop operation . 46
7.1.17.5 IDL description . 47
7.1.18 RtObject object . 47

---------------------- Page: 6 ----------------------

SIST ETS 300 714 E1:2003
Page 5
ETS 300 714: May 1997
7.1.18.1 bind operation.47
7.1.18.2 unbind operation.48
7.1.18.3 new operation .48
7.1.18.4 delete operation.48
7.1.18.5 getAvailabilityStatus operation.49
7.1.18.6 getIdentifier operation.49
7.1.18.7 kill operation.50
7.1.18.8 getRunningStatus operation .50
7.1.18.9 IDL description.50
7.1.19 Socket object.51
7.1.19.1 bind operation.51
7.1.19.2 unbind operation.51
7.1.19.3 getIdentifier operation.52
7.1.19.4 kill operation.52
7.1.19.5 plug operation.52
7.1.19.6 setVisibleDurationPosition operation.53
7.1.19.7 getVisibleDurationPosition operation.53
7.1.19.8 IDL description.54
7.1.20 RtScript object.54
7.1.20.1 setParameters operation .54
7.1.20.2 getTerminationStatus operation .55
7.1.20.3 IDL description.55
7.1.21 RtComponentOrSocket object .55
7.1.21.1 setRGS operation .55
7.1.21.2 getRGS operation.56
7.1.21.3 setOpacity operation.56
7.1.21.4 setPresentationPriority operation.57
7.1.21.5 getOpacity operation.57
7.1.21.6 getEffectiveOpacity operation.58
7.1.21.7 getPresentationPriority operation .58
7.1.21.8 setVisibleDuration operation.58
7.1.21.9 setTemporalTermination operation .59
7.1.21.10 setCurrentTemporalPosition operation.59
7.1.21.11 setSpeed operation.60
7.1.21.12 setTimestones operation .61
7.1.21.13 getInitialTemporalPosition operation .61
7.1.21.14 getTerminalTemporalPosition operation.62
7.1.21.15 getVDLength operation.62
7.1.21.16 getTemporalTermination operation .62
7.1.21.17 getCurrentTemporalPosition operation.63
7.1.21.18 getSpeedRate operation.63
7.1.21.19 getOGTR operation .64
7.1.21.20 getEffectiveSpeedRate operation.64
7.1.21.21 getEffectiveOGTR operation .64
7.1.21.22 getTimestoneStatus operation.65
7.1.21.23 setPerceptibleSizeProjection operation.65
7.1.21.24 setAspectRatio operation.66
7.1.21.25 setVisibleSize operation .66
7.1.21.26 setVisibleSizesAdjustment operation.67
7.1.21.27 setBox operation.67
7.1.21.28 setDefaultBackground operation .68
7.1.21.29 setAttachmentPoint operation .69
7.1.21.30 setAttachmentPointPosition operation.69
7.1.21.31 setVisibleSizesAlignment operation.70
7.1.21.32 setMovingAbility operation.71
7.1.21.33 setResizingAbility operation.71
7.1.21.34 setScalingAbility operation.71
7.1.21.35 setScrollingAbility operation.72
7.1.21.36 getGSR operation.72
7.1.21.37 getPS operation.73
7.1.21.38 getAspectRatio operation .73
7.1.21.39 getPSAP operation .74
7.1.21.40 getVSGS operation.74

---------------------- Page: 7 ----------------------

SIST ETS 300 714 E1:2003
Page 6
ETS 300 714: May 1997
7.1.21.41 getVS operation . 74
7.1.21.42 getBox operation. 75
7.1.21.43 getDefaultBackground operation . 75
7.1.21.44 getVSIAP operation. 76
7.1.21.45 getVSIAPPosition operation. 76
7.1.21.46 getVSEAP operation . 76
7.1.21.47 getVSEAPPosition operation . 77
7.1.21.48 getMovingAbility operation . 77
7.1.21.49 getResizingAbility operation. 78
7.1.21.50 getScalingAbility operation. 78
7.1.21.51 getScrollingAbility operation. 78
7.1.21.52 setSelectability operation . 79
7.1.21.53 setSelectionStatus operation . 80
7.1.21.54 setSelectionPresentationEffectResponsibility operation. 80
7.1.21.55 getSelectability operation . 81
7.1.21.56 getEffectiveSelectability operation . 81
7.1.21.57 getSelectionStatus operation . 82
7.1.21.58 getSelectionMode operation . 82
7.1.21.59 getSelectionPresentationEffectResponsibility operation. 82
7.1.21.60 setModifiability operation. 83
7.1.21.61 setModificationStatus operation. 84
7.1.21.62 setModificationPresentationEffectResponsibility operation. 84
7.1.21.63 getModifiability operation. 85
7.1.21.64 getEffectiveModifiability operation. 85
7.1.21.65 getModificationStatus operation. 86
7.1.21.66 getModificationMode operation. 86
7.1.21.67 getModificationPresentationEffectResponsibility operation 86
7.1.21.68 setNoInteractionStyle operation . 87
7.1.21.69 IDL description . 87
7.1.22 RtComponent object. 92
7.1.22.1 IDL description . 92
7.1.23 RtCompositeOrStructuralSocket object. 92
7.1.23.1 setResizingStrategy operation . 92
7.1.23.2 getResizingStrategy operation . 92
7.1.23.3 setAudibleCompositionEffect operation. 93
7.1.23.4 getAudibleCompositionEffect operation. 93
7.1.23.5 getNumberOfSelectedSockets operation . 94
7.1.23.6 getNumberOfModifiedSockets operation. 94
7.1.23.7 setMenuInteractionStyle operation. 95
7.1.23.8 setScrollingListInteractionStyle operation . 95
7.1.23.9 IDL description . 96
7.1.24 RtComposite object . 97
7.1.24.1 IDL description . 97
7.1.25 StructuralSocket object. 97
7.1.25.1 IDL description . 97
7.1.26 RtGenericContentOrPresentableSocket object. 97
7.1.26.1 setAudibleVolume operation . 98
7.1.26.2 getInitialOriginalAudibleVolume operation . 98
7.1.26.3 getCurrentOriginalAudibleVolume operation. 99
7.1.26.4 getEffectiveOriginalAudibleVolume operation. 99
7.1.26.5 getPerceptibleAudibleVolume operation. 100
7.1.26.6 setButtonInteractionStyle operation . 100
7.1.26.7 IDL description . 101
7.1.27 RtGenericContent object . 101
7.1.27.1 IDL description . 101
7.1.28 GenericPresentableSocket object . 101
7.1.28.1 IDL description . 101
7.1.29 RtContentOrPresentableSocket object. 102
7.1.29.1 setSliderInteractionStyle operation . 102
7.1.29.2 setEntryFieldInteractionStyle operation. 103
7.1.29.3 IDL description . 103
7.1.30 RtContent object. 104
7.1.30.1 IDL description . 104

---------------------- Page: 8 ----------------------

SIST ETS 300 714 E1:2003
Page 7
ETS 300 714: May 1997
7.1.31 PresentableSocket object.104
7.1.31.1 IDL description.104
7.1.32 RtMultiplexedContentOrPresentableSocket object .104
7.1.32.1 setStreamChoice operation .104
7.1.32.2 getStreamChosen operation.105
7.1.32.3 IDL description.105
7.1.33 RtMultiplexedContent object .105
7.1.33.1 IDL description.105
7.1.34 MultiplexedPresentableSocket object .105
7.1.34.1 IDL description.105
7.1.35 Channel object .105
7.1.35.1 bind operation.106
7.1.35.2 unbind operation.106
7.1.35.3 new operation .106
7.1.35.4 delete operation.107
7.1.35.5 getRtAvailabilityStatus operation .107
7.1.35.6 getIdentifier operation.108
7.1.35.7 kill operation.108
7.1.35.8 setPerceptability operation .108
7.1.35.9 getPerceptability operation .109
7.1.35.10 getAssignedPerceptibles operation .109
7.1.35.11 IDL description.109
7.1.36 Parameter definition .110
7.1.37 Exceptions.124
7.1.37.1 InvalidTarget exception.124
7.1.37.2 InvalidParameter exception .124
7.1.37.3 NotBound exception .124
7.1.37.4 AlreadyBound exception.124
7.1.37.5 IDL definition.125
7.2 Optional primitives .125
Annex A (normative): Complete IDL definition of the MHEG API .126
History.127

---------------------- Page: 9 ----------------------

SIST ETS 300 714 E1:2003
Page 8
ETS 300 714: May 1997
Blank page

---------------------- Page: 10 ----------------------

SIST ETS 300 714 E1:2003
Page 9
ETS 300 714: May 1997
Foreword
This European Telecommunication Standard (ETS) has been produced by the Terminal Equipment (TE)
Technical Committee of the European Telecommunications Standards Institute (ETSI).
Introduction
This ETS specifies the abstract Application Programming Interface (API) for the manipulation of
multimedia and hypermedia information objects, i.e. the API that shall be provided by Multimedia and
Hypermedia Experts Group (MHEG) engines for their control by MHEG applications.
This ETS is part of
...