Interface for all players. More...

Inheritance diagram for Crosstales.Radio.IPlayer:

Public Member Functions
void	Play ()
	Plays the radio-station. More...

void	PlayOrStop ()
	Plays or stops the radio-station. More...

void	Stop ()
	Stops the playback of the radio-station. More...

void	Restart (float invokeDelay=Crosstales.Radio.Util.Constants.INVOKE_DELAY)
	Restarts the playback of the radio-station. More...

void	MuteOrUnMute ()
	Mute or unmute the playback of the record. More...

void	Mute ()
	Mute the playback of the record. More...

void	UnMute ()
	Unmute the playback of the record. More...

Properties
RadioStation	Station `[get, set]`
	Current RadioStation of this player. More...

bool	HandleFocus `[get, set]`
	Starts and stops the RadioPlayer depending on the focus and running state. More...

int	CacheStreamSize `[get, set]`
	Size of the cache stream in bytes. More...

bool	LegacyMode `[get, set]`
	Enable or disable legacy mode. Legacy mode disables all record information, but is more stable. More...

bool	CaptureDataStream `[get, set]`
	Capture the encoded PCM-stream from this player. More...

bool	SkipPreBuffering `[get, set]`
	Enable or disable skipping of the pre-buffering. Skip pre-buffering allows for faster playback, but is less resilient. More...

AudioSource	Source `[get]`
	Returns the AudioSource of for this player. More...

AudioCodec	Codec `[get]`
	Returns the codec of for this player. More...

float	PlayTime `[get]`
	Returns the current playtime of this player. More...

float	BufferProgress `[get]`
	Returns the current buffer progress in percent. More...

bool	isBuffering `[get]`
	Is this player buffering? More...

long	CurrentBufferSize `[get]`
	Returns the size of the current buffer in bytes. More...

bool	isPlayback `[get]`
	Is this player in playback-mode? More...

bool	isAudioPlaying `[get]`
	Is this player playing audio? More...

float	RecordPlayTime `[get]`
	Returns the playtime of the current audio record. More...

RecordInfo	RecordInfo `[get]`
	Returns the information about the current audio record. More...

RecordInfo	NextRecordInfo `[get]`
	Returns the information about the next audio record. This information is updated a few seconds before a new record starts. More...

float	NextRecordDelay `[get]`
	Returns the current delay in seconds until the next audio record starts. More...

long	CurrentDownloadSpeed `[get]`
	Returns the current download speed in Bytes per second. More...

Crosstales.Common.Util.MemoryCacheStream	DataStream `[get]`
	Returns the encoded PCM-stream from this player. More...

int	Channels `[get]`
	Current audio channels of the current station. More...

int	SampleRate `[get]`
	Current audio sample rate of the current station. More...

float	Volume `[get, set]`
	Current volume of this player. More...

float	Pitch `[get, set]`
	Current pitch of this player. More...

float	StereoPan `[get, set]`
	Current stereo pan of this player. More...

bool	isMuted `[get, set]`
	Is this player muted? More...

Detailed Description

Interface for all players.

Member Function Documentation

◆ Mute()

void Crosstales.Radio.IPlayer.Mute ( )

Mute the playback of the record.

Implemented in Crosstales.Radio.SimplePlayer, Crosstales.Radio.RadioPlayer, and Crosstales.Radio.BasePlayer.

◆ MuteOrUnMute()

void Crosstales.Radio.IPlayer.MuteOrUnMute ( )

Mute or unmute the playback of the record.

Implemented in Crosstales.Radio.BasePlayer.

◆ Play()

void Crosstales.Radio.IPlayer.Play ( )

Plays the radio-station.

Implemented in Crosstales.Radio.SimplePlayer, Crosstales.Radio.RadioPlayer, and Crosstales.Radio.BasePlayer.

◆ PlayOrStop()

void Crosstales.Radio.IPlayer.PlayOrStop ( )

Plays or stops the radio-station.

Implemented in Crosstales.Radio.BasePlayer.

◆ Restart()

void Crosstales.Radio.IPlayer.Restart ( float invokeDelay = Crosstales.Radio.Util.Constants.INVOKE_DELAY )

Restarts the playback of the radio-station.

Parameters

invokeDelay Delay for the restart (default: 0.4, optional)

Implemented in Crosstales.Radio.SimplePlayer, Crosstales.Radio.RadioPlayer, and Crosstales.Radio.BasePlayer.

◆ Stop()

void Crosstales.Radio.IPlayer.Stop ( )

Stops the playback of the radio-station.

Implemented in Crosstales.Radio.SimplePlayer, Crosstales.Radio.RadioPlayer, and Crosstales.Radio.BasePlayer.

◆ UnMute()

void Crosstales.Radio.IPlayer.UnMute ( )

Unmute the playback of the record.

Implemented in Crosstales.Radio.SimplePlayer, Crosstales.Radio.RadioPlayer, and Crosstales.Radio.BasePlayer.

Property Documentation

◆ BufferProgress

float Crosstales.Radio.IPlayer.BufferProgress

get

Returns the current buffer progress in percent.

Returns: The current buffer progress in percent.

◆ CacheStreamSize

int Crosstales.Radio.IPlayer.CacheStreamSize

getset

Size of the cache stream in bytes.

◆ CaptureDataStream

bool Crosstales.Radio.IPlayer.CaptureDataStream

getset

Capture the encoded PCM-stream from this player.

◆ Channels

int Crosstales.Radio.IPlayer.Channels

get

Current audio channels of the current station.

◆ Codec

AudioCodec Crosstales.Radio.IPlayer.Codec

get

Returns the codec of for this player.

Returns: The codec for this player.

◆ CurrentBufferSize

long Crosstales.Radio.IPlayer.CurrentBufferSize

get

Returns the size of the current buffer in bytes.

Returns: Size of the current buffer in bytes.

◆ CurrentDownloadSpeed

long Crosstales.Radio.IPlayer.CurrentDownloadSpeed

get

Returns the current download speed in Bytes per second.

Returns: Current download speed in Bytes per second.

◆ DataStream

Crosstales.Common.Util.MemoryCacheStream Crosstales.Radio.IPlayer.DataStream

get

Returns the encoded PCM-stream from this player.

Returns: Encoded PCM-stream from this player.

◆ HandleFocus

bool Crosstales.Radio.IPlayer.HandleFocus

getset

Starts and stops the RadioPlayer depending on the focus and running state.

◆ isAudioPlaying

bool Crosstales.Radio.IPlayer.isAudioPlaying

get

Is this player playing audio?

Returns: True if this player is playing audio.

◆ isBuffering

bool Crosstales.Radio.IPlayer.isBuffering

get

Is this player buffering?

Returns: True if this player is buffering.

◆ isMuted

bool Crosstales.Radio.IPlayer.isMuted

getset

Is this player muted?

◆ isPlayback

bool Crosstales.Radio.IPlayer.isPlayback

get

Is this player in playback-mode?

Returns: True if this player is in playback-mode.

◆ LegacyMode

bool Crosstales.Radio.IPlayer.LegacyMode

getset

Enable or disable legacy mode. Legacy mode disables all record information, but is more stable.

◆ NextRecordDelay

float Crosstales.Radio.IPlayer.NextRecordDelay

get

Returns the current delay in seconds until the next audio record starts.

Returns: Current delay in seconds until the next audio record starts.

◆ NextRecordInfo

RecordInfo Crosstales.Radio.IPlayer.NextRecordInfo

get

Returns the information about the next audio record. This information is updated a few seconds before a new record starts.

Returns: Information about the next audio record.

◆ Pitch

float Crosstales.Radio.IPlayer.Pitch

getset

Current pitch of this player.

◆ PlayTime

float Crosstales.Radio.IPlayer.PlayTime

get

Returns the current playtime of this player.

Returns: The current playtime of this player.

◆ RecordInfo

RecordInfo Crosstales.Radio.IPlayer.RecordInfo

get

Returns the information about the current audio record.

Returns: Information about the current audio record.

◆ RecordPlayTime

float Crosstales.Radio.IPlayer.RecordPlayTime

get

Returns the playtime of the current audio record.

Returns: Playtime of the current audio record.

◆ SampleRate

int Crosstales.Radio.IPlayer.SampleRate

get

Current audio sample rate of the current station.

◆ SkipPreBuffering

bool Crosstales.Radio.IPlayer.SkipPreBuffering

getset

Enable or disable skipping of the pre-buffering. Skip pre-buffering allows for faster playback, but is less resilient.

◆ Source

AudioSource Crosstales.Radio.IPlayer.Source

get

Returns the AudioSource of for this player.

Returns: The AudioSource for this player.

◆ Station

RadioStation Crosstales.Radio.IPlayer.Station

getset

Current RadioStation of this player.

◆ StereoPan

float Crosstales.Radio.IPlayer.StereoPan

getset

Current stereo pan of this player.

◆ Volume

float Crosstales.Radio.IPlayer.Volume

getset

Current volume of this player.

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

C:/Users/slaub/Unity/assets/Radio/RadioPro/Assets/Plugins/crosstales/Radio/Scripts/IPlayer.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Mute()

◆ MuteOrUnMute()

◆ Play()

◆ PlayOrStop()

◆ Restart()

◆ Stop()

◆ UnMute()

Property Documentation

◆ BufferProgress

◆ CacheStreamSize

◆ CaptureDataStream

◆ Channels

◆ Codec

◆ CurrentBufferSize

◆ CurrentDownloadSpeed

◆ DataStream

◆ HandleFocus

◆ isAudioPlaying

◆ isBuffering

◆ isMuted

◆ isPlayback

◆ LegacyMode

◆ NextRecordDelay

◆ NextRecordInfo

◆ Pitch

◆ PlayTime

◆ RecordInfo

◆ RecordPlayTime

◆ SampleRate

◆ SkipPreBuffering

◆ Source

◆ Station

◆ StereoPan

◆ Volume