mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-09-10 11:54:40 +00:00
151 lines
5.0 KiB
Plaintext
151 lines
5.0 KiB
Plaintext
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIInputStream;
|
|
interface nsIPresentationAvailabilityListener;
|
|
interface nsIPresentationRespondingListener;
|
|
interface nsIPresentationSessionListener;
|
|
|
|
%{C++
|
|
#define PRESENTATION_SERVICE_CID \
|
|
{ 0x1d9bb10c, 0xc0ab, 0x4fe8, \
|
|
{ 0x9e, 0x4f, 0x40, 0x58, 0xb8, 0x51, 0x98, 0x32 } }
|
|
#define PRESENTATION_SERVICE_CONTRACTID \
|
|
"@mozilla.org/presentation/presentationservice;1"
|
|
%}
|
|
|
|
[scriptable, uuid(12073206-0065-4b10-9488-a6eb9b23e65b)]
|
|
interface nsIPresentationServiceCallback : nsISupports
|
|
{
|
|
/*
|
|
* Called when the operation succeeds.
|
|
*/
|
|
void notifySuccess();
|
|
|
|
/*
|
|
* Called when the operation fails.
|
|
*
|
|
* @param error: error message.
|
|
*/
|
|
void notifyError(in nsresult error);
|
|
};
|
|
|
|
[scriptable, uuid(c177a13a-bf1a-48bf-8032-d415c3343c46)]
|
|
interface nsIPresentationService : nsISupports
|
|
{
|
|
/*
|
|
* Start a new presentation session and display a prompt box which asks users
|
|
* to select a device.
|
|
*
|
|
* @param url: The url of presenting page.
|
|
* @param sessionId: An ID to identify presentation session.
|
|
* @param origin: The url of requesting page.
|
|
* @param callback: Invoke the callback when the operation is completed.
|
|
* NotifySuccess() is called with |id| if a session is
|
|
* established successfully with the selected device.
|
|
* Otherwise, NotifyError() is called with a error message.
|
|
*/
|
|
void startSession(in DOMString url,
|
|
in DOMString sessionId,
|
|
in DOMString origin,
|
|
in nsIPresentationServiceCallback callback);
|
|
|
|
/*
|
|
* Send the message wrapped with an input stream to the session.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
* @param stream: The message is converted to an input stream.
|
|
*/
|
|
void sendSessionMessage(in DOMString sessionId,
|
|
in nsIInputStream stream);
|
|
|
|
/*
|
|
* Close the session.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
*/
|
|
void closeSession(in DOMString sessionId);
|
|
|
|
/*
|
|
* Terminate the session.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
*/
|
|
void terminateSession(in DOMString sessionId);
|
|
|
|
/*
|
|
* Register an availability listener. Must be called from the main thread.
|
|
*
|
|
* @param listener: The listener to register.
|
|
*/
|
|
void registerAvailabilityListener(in nsIPresentationAvailabilityListener listener);
|
|
|
|
/*
|
|
* Unregister an availability listener. Must be called from the main thread.
|
|
* @param listener: The listener to unregister.
|
|
*/
|
|
void unregisterAvailabilityListener(in nsIPresentationAvailabilityListener listener);
|
|
|
|
/*
|
|
* Register a session listener. Must be called from the main thread.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
* @param listener: The listener to register.
|
|
*/
|
|
void registerSessionListener(in DOMString sessionId,
|
|
in nsIPresentationSessionListener listener);
|
|
|
|
/*
|
|
* Unregister a session listener. Must be called from the main thread.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
*/
|
|
void unregisterSessionListener(in DOMString sessionId);
|
|
|
|
/*
|
|
* Register a responding listener. Must be called from the main thread.
|
|
*
|
|
* @param windowId: The window ID associated with the listener.
|
|
* @param listener: The listener to register.
|
|
*/
|
|
void registerRespondingListener(in uint64_t windowId,
|
|
in nsIPresentationRespondingListener listener);
|
|
|
|
/*
|
|
* Unregister a responding listener. Must be called from the main thread.
|
|
* @param windowId: The window ID associated with the listener.
|
|
*/
|
|
void unregisterRespondingListener(in uint64_t windowId);
|
|
|
|
/*
|
|
* Check if the presentation instance has an existent session ID at launch.
|
|
* An empty string is always returned at sender side. Whereas at receiver side
|
|
* the associated session ID is returned if the window ID and URI are matched;
|
|
* otherwise an empty string is returned.
|
|
*
|
|
* @param windowId: The inner window ID used to look up the session ID.
|
|
*/
|
|
DOMString getExistentSessionIdAtLaunch(in uint64_t windowId);
|
|
|
|
/*
|
|
* Notify the receiver page is ready for presentation use.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
* @param windowId: The inner window ID associated with the presentation
|
|
* session. (0 implies no window ID since no actual window
|
|
* uses 0 as its ID.)
|
|
*/
|
|
void notifyReceiverReady(in DOMString sessionId,
|
|
[optional] in uint64_t windowId);
|
|
|
|
/*
|
|
* Untrack the relevant info about the presentation session if there's any.
|
|
*
|
|
* @param sessionId: An ID to identify presentation session.
|
|
*/
|
|
void untrackSessionInfo(in DOMString sessionId);
|
|
};
|