README.md
1# AVSession Component
2
3## Introduction
4
5The AVSession component provides unified media control capabilities for the system. It enables users to use the system's Media Controller to control the playback behavior of third-party media applications on the local and remote devices and view related playback information.
6
7#### Architecture Objective
8
9The AVSession component aims to provide unified local and distributed media playback control capabilities and experience.
10
11The component uses a global playback control entry to fully present media information and distributed media device information, so users can operate remote media as they operate local media.
12
13The component provides simplified JS APIs for developers to quickly build media applications and easily access Media Controller to use distributed playback control capabilities.
14
15## Logical Architecture
16
17
18
19### Introduction to module responsibilities
20
21| module name | responsibilities |
22| ------------------------------------------------ | ------------------------------------------------------------ |
23| AVSession | A session object that supports configuring session properties and can proactively update playback status and metadata. |
24| AVSessionController | The controller object can obtain the playback status and metadata of the session, remotely send control commands to the session side, or listen to the update events of the session side by subscribing. |
25| AVSessionManager | Provides the ability to query and obtain a specified session controller for basic information about the system's global sessions, and to limit the app's permissions. |
26| AVPlaybackCommand(Playback control commands) | Used to describe the audio and video broadcast command tool class, the encapsulation object of the broadcast command, support setting and obtaining commands. |
27| AVSessionEvent(Playback control events) | A utility class that describes audio and video playback events, encapsulates session events, and is sent and received by the session controller. |
28| AVPlaybackState(Playback state) | A tool class that describes the status of audio and video playback, supporting cross-process delivery. |
29| AVSessionMetadata(Media metadata) | A utility class that describes session metadata information, represented as key-value pairs, and supports cross-process passing. |
30| AVSessionService(Session service) | The system global session manages the SA service and implements the lifecycle callback of the session service. |
31| AVSessionItem(Session records) | An object that describes a service-side session record, holds a session label, and updates the record synchronously based on the behavior of the session side. |
32| AVSessionStrategy(Session policies) | Contains system session distribution policies and session sequencing policies, and supports substitution. |
33| RemoteSessionSource(Distributed session control) | Used to send local sessions to the remote end and synchronize local session information. |
34| RemoteSessionSink(Distributed session control) | Used to receive remote sessions and synchronize remote session information. |
35
36Data and command interaction between applications and AVSessionService(Session Service) are carried in media sessions(AVSession). Applications store information(Session records) in AVSessionService through sessions. AVSessionService receives control commands(Playback control events and Playback control commands) from system applications or external systems and forwards them to the applications, which then provide the functions as instructed.
37
38- AVSession: An audio and video application applies for a session from AVSessionManager. It is then bound to the session. Through this session, the application and system exchange data and control commands. If an application does not apply for a session, it cannot run in the background.
39
40- AVSessionController: Media Controller applies for a controller from AVSessionManager. Through this controller, Media Controller controls the session, thereby controlling application behavior.
41
42- Distributed session control: After a local session is created, it is synchronized to a remote device, and a remote session is created. The remote session is controlled by sending control commands to the remote device's AVSessionService through its AVSessionController.
43
44## Directory Structure
45
46The structure of the repository directory is as follows:
47
48```
49/foundation/multimedia/av_session # Service code of the AVSession component
50├── frameworks # Framework code
51│ ├── common # Common framework code
52│ ├── js # JS framework implementation
53│ └── native # Native framework implementation
54├── interfaces # External APIs
55│ ├── inner_api # Native external API files
56│ └── kits # External JS API files
57├── sa_profile
58├── services # Service implementation
59│ ├── etc
60│ └── session
61│ ├── adapter # External dependency adaptation
62│ ├── ipc # IPC implementation
63│ └── server # Service code implementation
64│ └── remote # Distributed service implementation
65├── utils # Public library
66└── bundle.json # Compilation file
67```
68
69## Repositories Involved
70
71[**multimedia_av_session**](https://gitee.com/openharmony/multimedia_av_session)
