diff --git a/AVInput/doc/AVInputPlugin.md b/AVInput/doc/AVInputPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/AVInput/doc/AVInputPlugin.md +++ b/AVInput/doc/AVInputPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/ActivityMonitor/doc/ActivityMonitorPlugin.md b/ActivityMonitor/doc/ActivityMonitorPlugin.md index 866066ea3f..bbb86cd81b 100644 --- a/ActivityMonitor/doc/ActivityMonitorPlugin.md +++ b/ActivityMonitor/doc/ActivityMonitorPlugin.md @@ -1,6 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) - -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Bluetooth/doc/BluetoothPlugin.md b/Bluetooth/doc/BluetoothPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Bluetooth/doc/BluetoothPlugin.md +++ b/Bluetooth/doc/BluetoothPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/CompositeInput/doc/CompositeInputPlugin.md b/CompositeInput/doc/CompositeInputPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/CompositeInput/doc/CompositeInputPlugin.md +++ b/CompositeInput/doc/CompositeInputPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/ContinueWatching/doc/ContinueWatchingPlugin.md b/ContinueWatching/doc/ContinueWatchingPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/ContinueWatching/doc/ContinueWatchingPlugin.md +++ b/ContinueWatching/doc/ContinueWatchingPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/ControlService/doc/ControlServicePlugin.md b/ControlService/doc/ControlServicePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/ControlService/doc/ControlServicePlugin.md +++ b/ControlService/doc/ControlServicePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DTV/doc/DTVPlugin.md b/DTV/doc/DTVPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DTV/doc/DTVPlugin.md +++ b/DTV/doc/DTVPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DataCapture/doc/DataCapturePlugin.md b/DataCapture/doc/DataCapturePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DataCapture/doc/DataCapturePlugin.md +++ b/DataCapture/doc/DataCapturePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DeviceDiagnostics/doc/DeviceDiagnosticsPlugin.md b/DeviceDiagnostics/doc/DeviceDiagnosticsPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DeviceDiagnostics/doc/DeviceDiagnosticsPlugin.md +++ b/DeviceDiagnostics/doc/DeviceDiagnosticsPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DeviceIdentification/doc/DeviceIdentificationPlugin.md b/DeviceIdentification/doc/DeviceIdentificationPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DeviceIdentification/doc/DeviceIdentificationPlugin.md +++ b/DeviceIdentification/doc/DeviceIdentificationPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DeviceInfo/doc/DeviceInfoPlugin.md b/DeviceInfo/doc/DeviceInfoPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DeviceInfo/doc/DeviceInfoPlugin.md +++ b/DeviceInfo/doc/DeviceInfoPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DisplayInfo/doc/DisplayInfoPlugin.md b/DisplayInfo/doc/DisplayInfoPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DisplayInfo/doc/DisplayInfoPlugin.md +++ b/DisplayInfo/doc/DisplayInfoPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/DisplaySettings/doc/DisplaySettingsPlugin.md b/DisplaySettings/doc/DisplaySettingsPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/DisplaySettings/doc/DisplaySettingsPlugin.md +++ b/DisplaySettings/doc/DisplaySettingsPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/FrameRate/doc/FrameRatePlugin.md b/FrameRate/doc/FrameRatePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/FrameRate/doc/FrameRatePlugin.md +++ b/FrameRate/doc/FrameRatePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/FrontPanel/doc/FrontPanelPlugin.md b/FrontPanel/doc/FrontPanelPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/FrontPanel/doc/FrontPanelPlugin.md +++ b/FrontPanel/doc/FrontPanelPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/HdcpProfile/doc/HdcpProfilePlugin.md b/HdcpProfile/doc/HdcpProfilePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/HdcpProfile/doc/HdcpProfilePlugin.md +++ b/HdcpProfile/doc/HdcpProfilePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/HdmiCec/doc/HdmiCecPlugin.md b/HdmiCec/doc/HdmiCecPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/HdmiCec/doc/HdmiCecPlugin.md +++ b/HdmiCec/doc/HdmiCecPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/HdmiCecSink/doc/HdmiCecSinkPlugin.md b/HdmiCecSink/doc/HdmiCecSinkPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/HdmiCecSink/doc/HdmiCecSinkPlugin.md +++ b/HdmiCecSink/doc/HdmiCecSinkPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/HdmiCec_2/doc/HdmiCec_2Plugin.md b/HdmiCec_2/doc/HdmiCec_2Plugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/HdmiCec_2/doc/HdmiCec_2Plugin.md +++ b/HdmiCec_2/doc/HdmiCec_2Plugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/HdmiInput/doc/HdmiInputPlugin.md b/HdmiInput/doc/HdmiInputPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/HdmiInput/doc/HdmiInputPlugin.md +++ b/HdmiInput/doc/HdmiInputPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/LocationSync/doc/LocationSyncPlugin.md b/LocationSync/doc/LocationSyncPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/LocationSync/doc/LocationSyncPlugin.md +++ b/LocationSync/doc/LocationSyncPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/LoggingPreferences/doc/LoggingPreferencesPlugin.md b/LoggingPreferences/doc/LoggingPreferencesPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/LoggingPreferences/doc/LoggingPreferencesPlugin.md +++ b/LoggingPreferences/doc/LoggingPreferencesPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/MaintenanceManager/doc/MaintenanceManagerPlugin.md b/MaintenanceManager/doc/MaintenanceManagerPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/MaintenanceManager/doc/MaintenanceManagerPlugin.md +++ b/MaintenanceManager/doc/MaintenanceManagerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Messenger/doc/MessengerPlugin.md b/Messenger/doc/MessengerPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Messenger/doc/MessengerPlugin.md +++ b/Messenger/doc/MessengerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Monitor/doc/MonitorPlugin.md b/Monitor/doc/MonitorPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Monitor/doc/MonitorPlugin.md +++ b/Monitor/doc/MonitorPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/MotionDetection/doc/MotionDetectionPlugin.md b/MotionDetection/doc/MotionDetectionPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/MotionDetection/doc/MotionDetectionPlugin.md +++ b/MotionDetection/doc/MotionDetectionPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Network/doc/NetworkPlugin.md b/Network/doc/NetworkPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Network/doc/NetworkPlugin.md +++ b/Network/doc/NetworkPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/OCIContainer/doc/OCIContainerPlugin.md b/OCIContainer/doc/OCIContainerPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/OCIContainer/doc/OCIContainerPlugin.md +++ b/OCIContainer/doc/OCIContainerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/OpenCDMi/doc/OpenCDMiPlugin.md b/OpenCDMi/doc/OpenCDMiPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/OpenCDMi/doc/OpenCDMiPlugin.md +++ b/OpenCDMi/doc/OpenCDMiPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Packager/doc/PackagerPlugin.md b/Packager/doc/PackagerPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Packager/doc/PackagerPlugin.md +++ b/Packager/doc/PackagerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/PersistentStore/doc/PersistentStorePlugin.md b/PersistentStore/doc/PersistentStorePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/PersistentStore/doc/PersistentStorePlugin.md +++ b/PersistentStore/doc/PersistentStorePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/PlayerInfo/doc/PlayerInfoPlugin.md b/PlayerInfo/doc/PlayerInfoPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/PlayerInfo/doc/PlayerInfoPlugin.md +++ b/PlayerInfo/doc/PlayerInfoPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/RDKShell/doc/RDKShellPlugin.md b/RDKShell/doc/RDKShellPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/RDKShell/doc/RDKShellPlugin.md +++ b/RDKShell/doc/RDKShellPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/RemoteActionMapping/doc/RemoteActionMappingPlugin.md b/RemoteActionMapping/doc/RemoteActionMappingPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/RemoteActionMapping/doc/RemoteActionMappingPlugin.md +++ b/RemoteActionMapping/doc/RemoteActionMappingPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/ScreenCapture/doc/ScreenCapturePlugin.md b/ScreenCapture/doc/ScreenCapturePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/ScreenCapture/doc/ScreenCapturePlugin.md +++ b/ScreenCapture/doc/ScreenCapturePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/SecurityAgent/doc/SecurityAgentPlugin.md b/SecurityAgent/doc/SecurityAgentPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/SecurityAgent/doc/SecurityAgentPlugin.md +++ b/SecurityAgent/doc/SecurityAgentPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/StateObserver/doc/StateObserverPlugin.md b/StateObserver/doc/StateObserverPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/StateObserver/doc/StateObserverPlugin.md +++ b/StateObserver/doc/StateObserverPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/SystemAudioPlayer/doc/SystemAudioPlayerPlugin.md b/SystemAudioPlayer/doc/SystemAudioPlayerPlugin.md index 4b83d96449..f40c349494 100644 --- a/SystemAudioPlayer/doc/SystemAudioPlayerPlugin.md +++ b/SystemAudioPlayer/doc/SystemAudioPlayerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/SystemAudioPlayer/doc/SystemAudioPlayer_1.1.md b/SystemAudioPlayer/doc/SystemAudioPlayer_1.1.md deleted file mode 100644 index 2950f20f59..0000000000 --- a/SystemAudioPlayer/doc/SystemAudioPlayer_1.1.md +++ /dev/null @@ -1,588 +0,0 @@ - - - -# System Audio Player Plugin - -**Version: 1.1** - -**Status:** - -org.rdk.SystemAudioPlayer plugin for Thunder framework. - -### Table of Contents - -- [Introduction](#head.Introduction) -- [Description](#head.Description) -- [Configuration](#head.Configuration) -- [Methods](#head.Methods) -- [Event](#head.Event) -- [Notifications](#head.Notifications) - - -# Introduction - - -## Scope - -This document describes purpose and functionality of the org.rdk.SystemAudioPlayer plugin. It includes detailed specification about its configuration, methods provided and notifications sent. - - -## Case Sensitivity - -All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such. - - -## Acronyms, Abbreviations and Terms - -The table below provides and overview of acronyms used in this document and their definitions. - -| Acronym | Description | -| :-------- | :-------- | -| API | Application Programming Interface | -| HTTP | Hypertext Transfer Protocol | -| JSON | JavaScript Object Notation; a data interchange format | -| JSON-RPC | A remote procedure call protocol encoded in JSON | - -The table below provides and overview of terms and abbreviations used in this document and their definitions. - -| Term | Description | -| :-------- | :-------- | -| callsign | The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique. | - - -## References - -| Ref ID | Description | -| :-------- | :-------- | -| [HTTP](http://www.w3.org/Protocols) | HTTP specification | -| [JSON-RPC](https://www.jsonrpc.org/specification) | JSON-RPC 2.0 specification | -| [JSON](http://www.json.org/) | JSON specification | -| [Thunder](https://github.com/WebPlatformForEmbedded/Thunder/blob/master/doc/WPE%20-%20API%20-%20WPEFramework.docx) | Thunder API Reference | - - -# Description - -The SystemAudioPlayer plugin provides System Audio Playback functionality for the client applications.
-It supports various audio types (viz., pcm, mp3, wav) and can play them from one of the chosen source (viz., websocket, httpsrc, filesrc, data buffer).
-For PCM content, the application is expected to also provide the "format" of the content in addition to source type and audio type. -The format, audio type and source are [configurable](#method.config) at run time.
-It also supports [volume control](#method.setMixerLevels) of the content being played back, as well as primary program audio and -thus allowing the application to duck down volume of primary program audio when a system audio is played back, and restore it back when the system audio playback is complete.
- -**Note**: mp3 playback development is work in progress.
- -The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#ref.Thunder)]. - - -# Configuration -This plugin will start before TextToSpeech plugin. -The table below lists configuration options of the plugin. - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| callsign | string | Plugin instance name (default: *org.rdk.SystemAudioPlayer*) | -| classname | string | Class name: *org.rdk.SystemAudioPlayer* | -| locator | string | Library name: *libWPEFrameworkSystemAudioPlayer.so* | -| autostart | boolean | Determines if the plugin shall be started automatically along with the framework | - - -# Methods - -The following methods are provided by the org.rdk.SystemAudioPlayer plugin: - -SystemAudioPlayer interface methods: - -| Method | Description | -| :-------- | :-------- | -| [open](#method.open) | Open the System Audio Player -| [config](#method.config) | Configure PCM/MP3 audio source options | -| [setMixerLevels](#method.setMixerLevels) | Control Primary and audio player's volume | -| [play](#method.play) | Play the audio provided | -| [stop](#method.stop) | Stop the audio playback | -| [pause](#method.pause) | Pause the audio playback| -| [resume](#method.resume) | Resume the playback from where its paused | -| [close](#method.close) | Close the System Audio Player| - - - -## *openmethod* - -Open System Audio player. -

Open has 3 parameters.
-1- audiotype [ pcm, mp3, wav ]
-2- sourcetype [ websocket, httpsrc, filesrc, data ]
-3- playmode [ system , app ]
-

-audiotype pcm has option of playmode [ system, app ] -If any open() call playmode with non pcm audio type, it will be ignored. - - -**Note**: SystemAudioPlayer can have maximum 1 system and 1 app playmode player at a time.
-Open returns a unique player object "id", which shall be used by the app to do rest of the operations on the player.

-Also see: [close](#method.close) - -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.audiotype| string | pcm, mp3, wav can be passed as parameter -| params.sourcetype| string | websocket, httpsrc, filesrc, data can be passed as parameter | -| params.playmode| string | system, app can be passed as parameter - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.id | string | Unique player object "id" | -| result.success | boolean | Whether the request succeeded | - - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "2105", - "method": "org.rdk.SystemAudioPlayer.1.open", - "params": { - "audiotype": "pcm", - "sourcetype": "websocket", - "playmode": "system" - } -} -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "id": 1, - "success": true - } -} -``` - - -## *close method* - -Close the Player. -SystemAudioPlayer destroy the player object. i.e if its playing , player will be stopped and closed. All the setMixerlevels() settings will be restored. - -Also see: [open](#method.open) - -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string| open api return id | - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "3", - "method": "org.rdk.SystemAudioPlayer.1.close", - "params": { - "id": "1" - } -} -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - - -## *stop method* - -Stop the playback. - -Also see: [pause](#method.pause) - -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string| open api return id | - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "3", - "method": "org.rdk.SystemAudioPlayer.1.stop", - "params": { - "id": "1" - } -} -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - - -## *playmethod* - -Play the audio.
-audio source will be passed in this.
-**Note** If one player is using one playmode and another player try to play using same playmode,
- SystemAudioPlayer returns error(Hardware resource already acquired by session with the player's id).
- -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string | Payer id | -| params.url| string | url source
Example: file source file:///opt/beep.wav
Example: httpsource http://localhost:50050/nuanceEve/tts?voice=ava&language=en-US&rate=50&text=SETTINGS
Example: WebSocket ws://myserver:40001
Note: if no port number provided for web socket, player uses default port 40001
| - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "3", - "method": "org.rdk.SystemAudioPlayer.1.play", - "params": { - "id": "1", - "url": "ws://myserver:40001" - } -} -``` -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - -## *pausemethod* - -Pause the playback. -
Pause is supported only for httpsrc and file source type.
- -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string | player Object | -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "2105", - "method": "org.rdk.SystemAudioPlayer.1.pause", - "params": { - "id": "1" - } -} -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - -## *resumemethod* - -Resume the playback. -
Resume is supported only httpsrc and file source type.
- -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string | player id | -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "2105", - "method": "org.rdk.SystemAudioPlayer.1.resume", - "params": { - "id": "1" - } -} -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - - -## *configmethod* - -Configure the playback. -
This API must be called before [play](#method.play).
-Currently, only PCM audio source (audio/x-raw) requires to be configured using the "pcmconfig" parameter as one of the input to this method.
-Please refer the sample request below for more details.
-There may be more optional configuration params added in the future for PCM as well as other audio types.
-Supported audio/x-raw can be found from the below link. -https://gstreamer.freedesktop.org/documentation/rawparse/rawaudioparse.html#src - -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string | id the audio player object | -| params.pcmconfig | object | pcm config values see below example | - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc":"2.0", - "id":"378001", - "method":"org.rdk.SystemAudioPlayer.1.config", - "params":{ - "id":"1", - "pcmconfig":{ - "format":"S16LE", - "rate":"22050", - "channels":"1", - "layout":"interleaved" - } - } - -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - -## *setMixerLevelsmethod* - -App can set mixer level of the audio. -It can control primary volume audio as well as player's volume.
-Primary Volume & Player Volume are from 0-100.
-0 is minimum & 100 is maximum volume.
-0 volume means, user will not hear any audio on playback.
- -### Parameters - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.id| string | player id | -| params.primVolume| string| Primary audio volume | -| params.playerVolume| string| Player audio volume | - -### Result - -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.success | boolean | Whether the request succeeded | - -### Example - -#### Request - -```json -{ - "jsonrpc": "2.0", - "id": "2105", - "method": "org.rdk.SystemAudioPlayer.1.setMixerLevels", - "params": { - "id": "1", - "primaryVolume": "20", - "playerVolume": "7" - } -} - -``` - -#### Response - -```json -{ - "jsonrpc": "2.0", - "id": 2105, - "result": { - "success": true - } -} -``` - - -# Event - -Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [[Thunder](#ref.Thunder)] for information on how to register for a notification. - -The following event is provided by the org.rdk.SystemAudioPlayer plugin: - -SystemAudioPlayer interface event. -App has to register onsapevents() to get all notifications. -App will get event notification based on playback. - - -| Event | Description | -| :-------- | :-------- | -| [onsapevents](#event.onsapevents) | - -Player will be broadcasting the events to all the clients registered.
-it is the responsiblity of the client to check the id attribute and discards it if the id does not match.
- -eg:
-client 1 invokes open API(pcm,filesrc,system) and receives the id 1
-client 2 invokes open API(mp3,httpsrc,app) and receives the id 2
- -For all events happening **player will broadcast** to all the listners.
-```json -{ -"id":"2", -"event":"PLAYBACK_STARTED" -} -``` - -For the above event only client2 needs to respond, if any.
- - Each event will be of this format
- **Example**: -```json -{ - "jsonrpc": "2.0", - "method": "client.events.1.onsapevents", - "params": { - "id": 1, - "event": "PLAYBACK_STARTED" - } -} -``` - id is Player id. - -# *Notifications* - - The following are notifications which the register app will get.
- **Note**: web socket playback is continious, does not receive PLAYBACK_FINISHED, until and unless stream contains EOS.
- -| Event Name| Description | -| :-------- | :-------- | -| PLAYBACK_STARTED| When playback starts | -| PLAYBACK_FINISHED | When playback finishes normally ( web socket does not receive this event) | -| PLAYBACK_PAUSED| When playback paused -| PLAYBACK_RESUMED | When playback resumed | -| NETWORK_ERROR | When playback network error( httpsrc/web socket) | -| PLAYBACK_ERROR| Any other playback error(internal issue )| -| NEED_DATA| When buffer needs more data to play| - - - -``` - - diff --git a/SystemServices/doc/SystemPlugin.md b/SystemServices/doc/SystemPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/SystemServices/doc/SystemPlugin.md +++ b/SystemServices/doc/SystemPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Telemetry/doc/TelemetryPlugin.md b/Telemetry/doc/TelemetryPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Telemetry/doc/TelemetryPlugin.md +++ b/Telemetry/doc/TelemetryPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/TextToSpeech/doc/TextToSpeechPlugin.md b/TextToSpeech/doc/TextToSpeechPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/TextToSpeech/doc/TextToSpeechPlugin.md +++ b/TextToSpeech/doc/TextToSpeechPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Timer/doc/TimerPlugin.md b/Timer/doc/TimerPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Timer/doc/TimerPlugin.md +++ b/Timer/doc/TimerPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/TraceControl/doc/TraceControlPlugin.md b/TraceControl/doc/TraceControlPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/TraceControl/doc/TraceControlPlugin.md +++ b/TraceControl/doc/TraceControlPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/UsbAccess/doc/UsbAccessPlugin.md b/UsbAccess/doc/UsbAccessPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/UsbAccess/doc/UsbAccessPlugin.md +++ b/UsbAccess/doc/UsbAccessPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/UserPreferences/doc/UserPreferencesPlugin.md b/UserPreferences/doc/UserPreferencesPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/UserPreferences/doc/UserPreferencesPlugin.md +++ b/UserPreferences/doc/UserPreferencesPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/VoiceControl/doc/VoiceControlPlugin.md b/VoiceControl/doc/VoiceControlPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/VoiceControl/doc/VoiceControlPlugin.md +++ b/VoiceControl/doc/VoiceControlPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/Warehouse/doc/WarehousePlugin.md b/Warehouse/doc/WarehousePlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/Warehouse/doc/WarehousePlugin.md +++ b/Warehouse/doc/WarehousePlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/WebKitBrowser/doc/WebKitBrowserPlugin.md b/WebKitBrowser/doc/WebKitBrowserPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/WebKitBrowser/doc/WebKitBrowserPlugin.md +++ b/WebKitBrowser/doc/WebKitBrowserPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/WifiManager/doc/WifiPlugin.md b/WifiManager/doc/WifiPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/WifiManager/doc/WifiPlugin.md +++ b/WifiManager/doc/WifiPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly. diff --git a/XCast/doc/XCastPlugin.md b/XCast/doc/XCastPlugin.md index a8ede7d6a9..bbb86cd81b 100644 --- a/XCast/doc/XCastPlugin.md +++ b/XCast/doc/XCastPlugin.md @@ -1,5 +1,5 @@ The RDK Services documentation is hosted as a static web site. -[View Latest Documentation](https://rdkservices.github.io/rdkservices/#) +[View Latest Documentation](https://rdkcentral.github.io/rdkservices/#/README) -This file will be removed in a future release. The documentation markdown files for RDK services are written to the [docs/api](https://github.com/rdkcentral/rdkservices/tree/feature_doc_site/docs/api) folder during generation. Please update your bookmarks accordingly. +This file will be removed in a future release. The API markdown files for RDK services are located in the [docs/api](https://github.com/rdkcentral/rdkservices/tree/main/docs/api) folder. Please update your bookmarks accordingly.