IToiDlnaRendererManager Interface Reference
Description
- Technical Preview:
interface IToiDlnarendererManager is a TECHNICAL PREVIEW, it may change.
This is an interface to the DLNA DMR (Digital Media Renderer) manager, which is running as a platform service. The DMR manager handles the communication between the DMC and DMR, and sends the relevant requests to the application. The application uses this manager to register for DMR events, specifically media render requests and media render closing. The application then may open the required resource, and notify the DMR manager to continue with the rendering, or deny the request and not render.
import "IToiDlnaRendererManager.idl";
List of all members.
Member Typedef Documentation
Type for a renderer session ID.
Type for holding a sequence of renderer session ID's.
Member Enumeration Documentation
State identifier used to identify the renderer session's state.
- Enumerator:
STATE_SESSION_REQUEST |
In STATE_SESSION_REQUEST the DMR has issued a request to begin rendering and is waiting for an update to begin or close the rendering session.
|
STATE_SESSION_ACTIVE |
In STATE_SESSION_ACTIVE the DMR is actively rendering the requested session.
|
STATE_SESSION_CLOSED |
In STATE_SESSION_CLOSED the DMR has closed the given session. This can occur at the end of media, an error in rendering, or from an update from the application.
|
Status identifiers for a DMR session.
- Enumerator:
RENDERER_SUCCESS |
RENDERER_SUCCESS notifies the DMR the request to render was successful.
|
RENDERER_UNAVAILABLE |
RENDERER_UNAVAILABLE notifies the DMR the request to render failed, or the currently rendering media must close, because the renderer is unavailable.
|
RENDERER_FAILURE |
RENDERER_FAILURE notifies the DMR the request to render failed, or the currently rendering media must close, because of an external failure.
|
Member Function Documentation
Retreives all the session id's in REQUEST or ACTIVE states
- Return values:
-
| ids | The list of active session ids. |
Retreives all the information associated with the current media being rendered for the session id provided.
- Parameters:
-
| id | The session ID associated with the media in question. |
- Return values:
-
| info | The information associated with the given session id. |
- Exceptions:
-
void IToiDlnaRendererManager::ReleaseInstance |
( |
|
) |
|
When an application is done using the Renderer Manager it should gracefully release it by calling this function.
Notifies the DMR of an update to the session. This typically will occur when 1, we just received a request, so we will activate a session (if successful) or notify a failure to renderer (if unsuccessful); 2, if the rendering resouce becomes unavailable during rendering; or 3, for any other error while rendering. This may cause a change in State, from REQUEST to ACTIVE (on successful REQUEST), from REQUEST to CLOSED (on unsuccessful REQUEST), or from ACTIVE to CLOSED (on error or resource unavailability).
- Parameters:
-
| id | The session ID being updated. |
| status | The status for this session's action. |
- Exceptions:
-