Collapse all Symbian^3 Application Developer Library

MMPXPlayerManager Class Reference

class MMPXPlayerManager

Manages the players. Golden rules: by default, all players of type EPbLocal are tried and the first one found which can handle the content is used; when a specific player is selected by uid, (i.e. SelectPlayerL(TUid aPlayer) ) then only that player will be considered in the search; when players are selected by type (i.e. SelectPlayersL(TMPXPlaybackPlayerType aType) ), then only players with that type are considered; When a sub player is explicitly selected (i.e. SelectSubPlayerL() ), then only that player and its sub player are considered.

mpxplaybackutility.lib

Public Member Functions
void	ClearSelectPlayersL ()
MMPXPlayer *	CurrentPlayer ()
void	GetPlayerListL ( RArray < TUid > &)
void	GetPlayerListL ( RArray < TUid > &, TMPXPlaybackPlayerType )
void	GetPlayerTypesL ( RArray < TMPXPlaybackPlayerType > &)
void	GetSelectionL ( TMPXPlaybackPlayerType &, TUid &, TInt &, HBufC *&)
HBufC *	PlayerTypeDisplayNameL ( TMPXPlaybackPlayerType )
void	SelectPlayerL ( TUid )
void	SelectPlayersL ( TMPXPlaybackPlayerType )
void	SelectSubPlayerL ( TUid , TInt )
void	SubPlayerNamesL (MMPXPlaybackCallback &, TUid )

Member Functions Documentation

ClearSelectPlayersL()

void

ClearSelectPlayersL

(

)

[pure virtual]

Clears all selection criteria. Essentially the same as SelectPlayersL(EPbLocal).

Since: S60 3.2.3

CurrentPlayer()

MMPXPlayer *

CurrentPlayer

(

)

[pure virtual]

The current player, may change with each item, NULL if none found.

Since: S60 3.2.3

GetPlayerListL(RArray< TUid > &)

void

GetPlayerListL

(

RArray < TUid > &

aPlayers

)

[pure virtual]

Get the list of UIDs of all players.

Since: S60 3.2.3

Parameters

RArray < TUid > & aPlayers

All the players' uids in the system

GetPlayerListL(RArray< TUid > &, TMPXPlaybackPlayerType)

void	GetPlayerListL	(	RArray < TUid > &	aPlayers,
			TMPXPlaybackPlayerType	aType
		)	[pure virtual]

Get the list of UIDs of players with the specific type.

Since: S60 3.2.3

Parameters

RArray < TUid > & aPlayers	All the players' uids with the same type
TMPXPlaybackPlayerType aType	the type of players

GetPlayerTypesL(RArray< TMPXPlaybackPlayerType > &)

void

GetPlayerTypesL

(

RArray < TMPXPlaybackPlayerType > &

aTypes

)

[pure virtual]

Typically, a client will obtain the list of all the (non-duplicated) player 'types' in the system from GetPlayerTypesL and present localized type names (e.g. "Local","Home network", if possible, else if non-standard type,should use PlayerTypeDisplayNameL to get text from player).

User should be given opportunity to choose IF there is more than one type available, or if there is one type but more than one sub players, the user could be presented with the sub player list.

Since: S60 3.2.3

Parameters

RArray < TMPXPlaybackPlayerType > & aTypes

the list of player types

GetSelectionL(TMPXPlaybackPlayerType &, TUid &, TInt &, HBufC *&)

void	GetSelectionL	(	TMPXPlaybackPlayerType &	aType,
			TUid &	aPlayer,
			TInt &	aSubPlayerIndex,
			HBufC *&	aSubPlayerName
		)	[pure virtual]

Retreives the current selection: KNullUid and KErrNotFound are possible return values for aPlayer and aSubPlayerIndex respectively if none are explicitly selected.

Since: S60 3.2.3

Parameters

TMPXPlaybackPlayerType & aType	player type
TUid & aPlayer	the UID of player
TInt & aSubPlayerIndex	index of the subplayer
HBufC *& aSubPlayerName	friendly name of the subplayer. Notes: Client owns the returned aSubPlayerName object.

PlayerTypeDisplayNameL(TMPXPlaybackPlayerType)

HBufC *

PlayerTypeDisplayNameL

(

TMPXPlaybackPlayerType

aType

)

[pure virtual]

Returns display name for custom types; standard types should be recognized by client and localized - calling this method would then not be required.

Since: S60 3.2.3

Parameters

TMPXPlaybackPlayerType aType

playback type

SelectPlayerL(TUid)

void

SelectPlayerL

(

TUid

aPlayer

)

[pure virtual]

Client selects a specific player. NOTE: Once a player is manually selected by UID, all subsequent InitL() will continue to use that player, it will not try to resolve a plugin. If the client later wants the engine to auto resolve the proper plugin, the client must call ClearSelectPlayersL() to reset the engine.

Since: S60 3.2.3

Parameters

TUid aPlayer

the UID of the player

SelectPlayersL(TMPXPlaybackPlayerType)

void

SelectPlayersL

(

TMPXPlaybackPlayerType

aType

)

[pure virtual]

Client selects all players with the type aType, the specific player used then being resolved on the basis of the content.

Since: S60 3.2.3

Parameters

TMPXPlaybackPlayerType aType

the type of player

SelectSubPlayerL(TUid, TInt)

void	SelectSubPlayerL	(	TUid	aPlayer,
			TInt	aSubPlayerIndex
		)	[pure virtual]

Client selects specific player aPlayer and sub player aSubPlayerIndex from array returned by SubPlayerNamesL. NOTE: Once a player is manually selected by UID, all subsequent InitL() will continue to use that player, it will not try to resolve a plugin. If the client later wants the engine to auto resolve the proper plugin, the client must call ClearSelectPlayersL() to reset the engine.

Since: S60 3.2.3

Parameters

TUid aPlayer	the UID of player
TInt aSubPlayerIndex	the index of the sub player

SubPlayerNamesL(MMPXPlaybackCallback &, TUid)

void	SubPlayerNamesL	(	MMPXPlaybackCallback &	aCallback,
			TUid	aPlayer
		)	[pure virtual]

Get the list of sub player names, Async.

Since: S60 3.2.3

Parameters

MMPXPlaybackCallback & aCallback	sub players returned in call back interface
TUid aPlayer	UID of the player