ToiMediaServiceSessionInfo Interface Reference

---

Description

This is the documentation for ToiMediaServiceSessionInfo.
Information about a media session. Use toi.statics.ToiMediaServiceSessionInfo.create(<id>, <type>, <url>, <state>, <reason>) to create an instance of ToiMediaServiceSessionInfo. The following parameters in the create method are optional: <reason>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiMediaServiceSessionInfo.idl";

List of all members.

Public Attributes
attribute ToiMediaSession::TToiSessionId	id
attribute ToiMediaSession::TToiSessionType	type
attribute string	url
attribute ToiMediaSession::TToiState	state
attribute string	reason

---

Member Data Documentation

attribute ToiMediaSession::TToiSessionId ToiMediaServiceSessionInfo::id

The session identifier.

attribute string ToiMediaServiceSessionInfo::reason

Technical Preview:

This field may change. The reason for the state change.

attribute ToiMediaSession::TToiState ToiMediaServiceSessionInfo::state

The current session state.

attribute ToiMediaSession::TToiSessionType ToiMediaServiceSessionInfo::type

Bitmask for the types of the session, e.g. player and recorder types when the session is used for time shifting. Constants for the possible types are available in ToiMediaSession.

attribute string ToiMediaServiceSessionInfo::url

The source URL for the session.