QMediaSessionRequest Class Reference
[QtMediaModule]

Detailed Description

The QMediaSessionRequest class provides an object that is passed by clients to the Media Server to start a new media session.

A QMediaSessionRequest is not usually created directly. The Qt Extended Media API will create a session in response to a call to one of its functions to play media content. A Media Engine that provides a QMediaSessionBuilder of the same type as the request may be asked to fulfill the request. Each request carries - a session identifier, valid for the lifetime of the session. - a domain, the media domain in which this session should be created, this effects management of the media content. - a type, which is used to identify the type of the request.

See also QMediaSessionBuilder.

Member Function Documentation

QMediaSessionRequest::QMediaSessionRequest ()

Construct an empty QMediaSessionRequest.

QMediaSessionRequest::QMediaSessionRequest ( QString const & domain, QString const & type )

Construct a QMediaSessionRequest in the Media domain and of type.

QMediaSessionRequest::QMediaSessionRequest ( QMediaSessionRequest const & copy )

Construct QMediaSessionRequest taking a copy of another.

QMediaSessionRequest::~QMediaSessionRequest ()

Destruct a QMediaSessionRequest

QString const & QMediaSessionRequest::domain () const

Returns the domain that this session will be allocated in.

QUuid const & QMediaSessionRequest::id () const

Returns the session id of this request. The session id is automatically generated, and is valid for the life time of a session.

QString const & QMediaSessionRequest::type () const

Returns the type of the session.

QMediaSessionRequest & QMediaSessionRequest::operator<< ( DataType const & data )

The input-to operator for QMediaSessionRequest. This operator is used to add any extra arguments for the request. The data value is added to an internal queue of arguments.

QMediaSessionRequest & QMediaSessionRequest::operator= ( QMediaSessionRequest const & rhs )

Assignment operator for QMediaSessionRequest, taking its value from rhs.

QMediaSessionRequest & QMediaSessionRequest::operator>> ( DataType & data )

The output-to operator for the QMediaSessionRequest. This operator is used to extract arguments from the request. The data value is removed from an internal queue of arguments.