Linphone.Player Class Reference

Inheritance diagram for Linphone.Player:

Public Member Functions
void	Close ()
IntPtr	CreateWindowId (IntPtr context)
IntPtr	CreateWindowId ()
void	Open (string filename)
void	Pause ()
void	Seek (int timeMs)
void	Start ()

Properties
PlayerListener	Listener [get, set]
Linphone.Core	Core [get]
int	CurrentPosition [get]
int	Duration [get]
bool	IsVideoAvailable [get]
Linphone.PlayerState	State [get]
float	VolumeGain [get, set]
IntPtr	WindowId [set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Player interface.

Member Function Documentation

void Linphone.Player.Close ( )

inline

Close the opened file.

IntPtr Linphone.Player.CreateWindowId ( IntPtr  context )

inline

Create a window id to be used to display video if any.

A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used.

Parameters

context

preallocated Window ID (Used only for MSOGL)

Returns

window_id The window id pointer to use.

IntPtr Linphone.Player.CreateWindowId ( )

inline

Create a window id to be used to display video if any.

Returns

window_id The window id pointer to use.

void Linphone.Player.Open ( string  filename )

inline

Open a file for playing.

Actually, only WAVE and MKV/MKA file formats are supported and a limited set of codecs depending of the selected format. Here are the list of working combinations: -WAVE format: only PCM s16le codec is supported. -MKV/MKA format:

Parameters

filename

The path to the file to open

void Linphone.Player.Pause ( )

inline

Pause the playing of a file.

Returns

0 on success, a negative value otherwise

void Linphone.Player.Seek ( int  timeMs )

inline

Seek in an opened file.

Parameters

timeMs

The time we want to go to in the file (in milliseconds).

Returns

0 on success, a negative value otherwise.

void Linphone.Player.Start ( )

inline

Start playing a file that has been opened with Linphone.Player.Open().

Returns

0 on success, a negative value otherwise

Property Documentation

Linphone.Core Linphone.Player.Core

get

Returns the Linphone.Core object managing this player's call, if any.

Returns

the Linphone.Core object associated

int Linphone.Player.CurrentPosition

get

Get the current position in the opened file.

Returns

The current position in the opened file

int Linphone.Player.Duration

get

Get the duration of the opened file.

Returns

The duration of the opened file

bool Linphone.Player.IsVideoAvailable

get

Returns whether the file has video and if it can be displayed.

Returns

true if file has video and it can be displayed, false otherwise

Linphone.PlayerState Linphone.Player.State

get

Get the current state of a player.

Returns

The current Linphone.PlayerState of the player.

float Linphone.Player.VolumeGain

getset

Get the volume gain of the player.

Returns

Percentage of the gain. Valid values are in [ 0.0 : 1.0 ].

IntPtr Linphone.Player.WindowId

set

Sets a window id to be used to display video if any.

Parameters

windowId

The window id pointer to use.

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs