ETSI TS 103 544-15 V1.3.1 (2019-10)

Publicly Available Specification (PAS); Intelligent Transport Systems (ITS); MirrorLink®; Part 15: Application Programming Interface (API) Level 1 & 2

RTS/ITS-98-15

General Information

• Status: Published
• Publication Date: 08-Oct-2019
• Technical Committee: ITS - Intelligent Transport Systems
• Current Stage: 12 - Completion
• Due Date: 30-Sep-2019
• Completion Date: 09-Oct-2019

Standards Content (Sample)

ETSI TS 103 544-15 V1.3.1 (2019-10)






TECHNICAL SPECIFICATION
Publicly Available Specification (PAS);
Intelligent Transport Systems (ITS);
®
MirrorLink ;
Part 15: Application Programming Interface (API) Level 1 & 2
CAUTION

The present document has been submitted to ETSI as a PAS produced by CCC and
approved by the ETSI Technical Committee Intelligent Transport Systems (ITS).
CCC is owner of the copyright of the document CCC-TS-038 and/or had all relevant rights and had assigned said rights to
ETSI on an "as is basis". Consequently, to the fullest extent permitted by law, ETSI disclaims all warranties whether express,
implied, statutory or otherwise including but not limited to merchantability, non-infringement of any intellectual property rights of
third parties. No warranty is given about the accuracy and the completeness of the content of the present document.

---------------------- Page: 1 ----------------------
2 ETSI TS 103 544-15 V1.3.1 (2019-10)



Reference
RTS/ITS-98-15
Keywords
interface, ITS, PAS, smartphone

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm
except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
©ETSI 2019.
© Car Connectivity Consortium 2011-2019.
All rights reserved.
ETSI logo is a Trade Mark of ETSI registered for the benefit of its Members.
MirrorLink® is a registered trademark of Car Connectivity Consortium LLC.
RFB® and VNC® are registered trademarks of RealVNC Ltd.
UPnP® is a registered trademark of Open Connectivity Foundation, Inc.
Other names or abbreviations used in the present document may be trademarks of their respective owners.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
3 ETSI TS 103 544-15 V1.3.1 (2019-10)
Contents
Intellectual Property Rights . 7
Foreword . 7
Modal verbs terminology . 7
1 Scope . 8
2 References . 8
2.1 Normative references . 8
2.2 Informative references . 9
3 Definition of terms, symbols and abbreviations . 9
3.1 Terms . 9
3.2 Symbols . 9
3.3 Abbreviations . 9
4 Introduction . 10
5 Definitions . 12
5.1 0xE001 - Structure Rect . 12
5.2 0xE002 - Structure ServiceInfo . 12
5.3 0xE003 - Structure Action . 12
5.4 0xE004 - FbContext . 13
6 MirrorLink API Elements . 13
6.1 Introduction . 13
6.2 0xF0xx - MirrorLink API Info . 14
6.2.1 0xF001 - MirrorLink API Version . 14
6.2.2 0xF002 - MirrorLink API Module Available. 14
6.2.3 0xF003 - Server Device Identifier . 15
6.3 0x01xx - MirrorLink Device Info . 15
6.3.1 0x0101 - MirrorLink Version . 15
6.3.2 0x0102 - MirrorLink Version Callback . 15
6.3.3 0x0103 - MirrorLink Client Manufacturer and Model Information. 16
6.3.4 0x0104 - MirrorLink Client Manufacturer and Model Information Callback . 16
6.3.5 0x0105 - Server Device Virtual Keyboard Support . 17
6.3.6 0x0106 - MirrorLink Client Driver Distraction Information . 17
6.3.7 0x0107 - MirrorLink Client Driver Distraction Information Callback . 17
6.3.8 0x0108 - MirrorLink Client Character Set Support . 18
6.3.9 0x0109 - MirrorLink Client Character Set Support Callback . 18
6.3.10 0x010A - MirrorLink Client Audio Latency Characteristics Information . 18
6.3.11 0x010B - MirrorLink Client Audio Latency Characteristics Callback . 19
6.3.12 0x010C - MirrorLink Voice Interaction Support Information . 19
6.3.13 0x010D - MirrorLink Voice Interaction Support Information Callback . 20
6.3.14 0x010E - MirrorLink UI Mode Information . 20
6.3.15 0x010F - MirrorLink UI Mode Information Callback . 20
6.3.16 0x0110 - MirrorLink Server Manufacturer and Model Information . 21
6.3.17 0x0111 - MirrorLink UI Control Information . 21
6.3.18 0x0112 - MirrorLink UI Control Information Callback. 21
6.3.19 0x0113 - MirrorLink Server Status Indicators Information . 22
6.3.20 0x0114 - MirrorLink Server Status Indicators Information Callback . 22
6.4 0x02xx - Certification Information . 22
6.4.1 0x0201 - Get Application Certification Status . 22
6.4.2 0x0202 - Get Application Certifying Entities . 23
6.4.3 0x0203 - Get Application Certification Information . 23
6.4.4 0x0204 - Get Application Certification Information Callback . 23
6.4.5 0x0205 - Get Certified Applications Identifier List . 24
6.4.6 0x0206 - Get Any Application Certification Status . 24
6.4.7 0x0207 - Get Any Application Certifying Entities . 25
6.4.8 0x0208 - Get Any Application Certification Information . 25
ETSI

---------------------- Page: 3 ----------------------
4 ETSI TS 103 544-15 V1.3.1 (2019-10)
6.4.9 0x0209 - Get Certified Applications List Changed Callback . 26
6.5 0x03xx - Connection Information . 26
6.5.1 0x0301 - Established MirrorLink Connection . 26
6.5.2 0x0302 - Established MirrorLink Connection Callback . 27
6.5.3 0x0303 - Established Audio Connections . 27
6.5.4 0x0304 - Established Audio Connections Callback . 28
6.5.5 0x0305 - Established Remote Display Connection . 29
6.5.6 0x0306 - Established Remote Display Connection Callback . 29
6.6 0x04xx - Display Information . 29
6.6.1 General . 29
6.6.2 0x0401 - Display Configuration . 30
6.6.3 0x0402 - Display Configuration Callback . 31
6.6.4 0x0403 - Client Pixel Format . 32
6.6.5 0x0404 - Client Pixel Format Callback. 32
6.6.6 0x0405 - Set Framebuffer Orientation Support . 33
6.6.7 0x0406 - Switch Framebuffer Orientation Callback . 33
6.7 0x05xx - Event Information . 33
6.7.1 0x0501 - Event Configuration . 33
6.7.2 0x0502 - Event Configuration Callback . 34
6.7.3 0x0503 - Get Remapped Events . 35
6.7.4 0x0504 - Get Event Mapping . 35
6.7.5 0x0505 - Get Event Mapping Callback. 35
6.8 0x06xx - Client Virtual Keyboard . 36
6.8.1 0x0601 - Show Client Virtual Keyboard . 36
6.8.2 0x0602 - Client Virtual Keyboard Support . 36
6.8.3 0x0603 - Client Virtual Keyboard Text Entry Callback . 37
6.9 0x07xx - Key Event Listing . 37
6.9.1 0x0701 - Key Event List . 37
6.9.2 0x0702 - Key Event List Support . 37
6.10 0x08xx - Context Information . 38
6.10.1 0x0801 - Framebuffer Context Information . 38
6.10.2 0x0802 - Framebuffer Blocking Information Callback . 38
6.10.3 0x0803 - Audio Context Information. 39
6.10.4 0x0804 - Audio Blocking Information Callback . 41
6.10.5 0x0805 - Framebuffer Unblocking Callback . 41
6.10.6 0x0806 - Audio Unblocking Callback . 42
6.10.7 0x0807 - Audio In Foreground . 42
6.10.8 0x0808 - Audio In Foreground Callback . 42
6.10.9 0x0809 - UI In Foreground . 42
6.10.10 0x080A - UI In Foreground Callback . 43
6.11 0x09xx - Device Status Information . 43
6.11.1 0x0901 - Drive Mode . 43
6.11.2 0x0902 - Drive Mode Callback. 43
6.11.3 0x0903 - Night Mode . 44
6.11.4 0x0904 - Night Mode Callback. 44
6.11.5 0x0905 - Microphone State . 44
6.11.6 0x0906 - Open Microphone Callback . 44
6.11.7 0x0907 - Set Open Microphone . 45
6.12 0x0Axx - Data Services . 45
6.12.1 General . 45
6.12.2 0x0A01 - Get Available Services . 45
6.12.3 0x0A02 - Available Services Callback . 46
6.12.4 0x0A03 - Register to a Service . 46
6.12.5 0x0A04 - Register to a Service Callback . 47
6.12.6 0x0A05 - Unregister from a Service . 48
6.12.7 0x0A06 - Subscribe to an Object . 49
6.12.8 0x0A07 - Subscribe to an Object Callback . 49
6.12.9 0x0A08 - Unsubscribe from an Object . 50
6.12.10 0x0A09 - Set an Object . 50
6.12.11 0x0A0A - Set Object Callback . 51
6.12.12 0x0A0B - Get an Object . 51
6.12.13 0x0A0C - Received Object Callback . 51
ETSI

---------------------- Page: 4 ----------------------
5 ETSI TS 103 544-15 V1.3.1 (2019-10)
6.12.14 0x0A0D - Request to Update an Object Callback . 52
6.12.15 0x0A0E - Set Data Object Response . 54
6.13 0x0Bxx - Notifications . 55
6.13.1 0x0B01 - Notifications Supported . 55
6.13.2 0x0B02 - Notifications Enabled. 55
6.13.3 0x0B03 - Notifications Enabled Callback . 55
6.13.4 0x0B04 - Notification Configuration . 56
6.13.5 0x0B05 - Notification Configuration Callback . 56
6.13.6 0x0B06 - Send Notification for client-based Notification UI . 57
6.13.7 0x0B07 - Send Notification for VNC-based Notification UI . 57
6.13.8 0x0B08 - Cancel Notification . 58
6.13.9 0x0B09 - Receive Action Callback . 58
6.13.10 0x0B0A - Send Notification for Voice-based Notification UI . 58
6.13.11 0x0B0B - Initiate Voice-based Interaction . 59
6.13.12 0x0B0C - Notification Failed Callback . 59
6.14 0x0Cxx - Actions . 59
6.14.1 General . 59
6.14.2 0x0C01 - Create Application Actions . 60
6.14.3 0x0C02 - Update Application Actions . 60
6.14.4 0x0C03 - Retrieve Application Actions . 61
6.14.5 0x0C04 - Delete Application Actions . 61
6.14.6 0x0C05 - Get Certified Actions . 61
6.14.7 0x0C06 - Invoke Action . 62
6.14.8 0x0C07 - Action Invoked Callback . 62
7 Dictionary of MirrorLink Action Types . 63
7.1 General . 63
7.2 Variants . 63
7.2.1 ACTION_VARIANT . 63
7.3 Alarm and Timer . 63
7.3.1 ACTION_SET_ALARM . 63
7.3.2 ACTION_SET_TIMER . 63
7.3.3 ACTION_DISMISS_ALARM . 63
7.3.4 ACTION_SNOOZE_ALARM . 63
7.4 Telephony and Messaging . 63
7.4.1 ACTION_DIAL . 63
7.4.2 ACTION_CALL . 63
7.4.3 ACTION_TEXT . 63
7.5 Media Playback . 63
7.5.1 ACTION_PLAY_MEDIA . 63
7.5.2 ACTION_PLAY . 64
7.5.3 ACTION_PAUSE . 64
7.5.4 ACTION_NEXT . 64
7.5.5 ACTION_PREVIOUS . 64
7.5.6 ACTION_SHUFFLE . 64
7.5.7 ACTION_REPEAT . 64
7.5.8 ACTION_MUTE . 64
7.6 Application Launching . 64
7.6.1 ACTION_OPEN_APPLICATION . 64
7.7 Response to Voice-Based Notifications . 64
7.7.1 ACTION_RESPONSE_YES . 64
7.7.2 ACTION_RESPONSE_NO . 64
7.7.3 ACTION_RESPONSE_FREE _FORM_SPEECH . 64
7.4.4 ACTION_RESPONSE_FREE _FORM_ AUDIO . 64
7.8 Miscellaneous . 65
7.8.1 ACTION_CREATE_NOTE . 65
7.9 MirrorLink Home Screen .
...