Crosstales.DJ.IPlayer Interface Reference

Interface for all players. More...

Inheritance diagram for Crosstales.DJ.IPlayer:
Crosstales.DJ.BasePlayer Crosstales.DJ.SimplePlayer Crosstales.DJ.Turntable

Public Member Functions

void Play ()
 Plays the record. More...
 
void PlayOrStop ()
 Plays or stops the record. More...
 
void Next ()
 Plays the next record. More...
 
void Previous ()
 Plays the previous record. More...
 
void PauseOrUnPause ()
 Pause or unpause the playback of the record. More...
 
void Pause ()
 Pauses the playback of the record. More...
 
void UnPause ()
 Unpause the playback of the record. More...
 
void Stop ()
 Stops the playback of the record. More...
 
void Restart ()
 Restarts the playback of the record. 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

Crosstales.DJ.Model.Record Record [get, set]
 Current record of this player. More...
 
bool isLoop [get, set]
 Loop the record on/off. More...
 
byte[] AudioData [get, set]
 Audio data for the current Record read outside of DJ (e.g. from the Android SAF). More...
 
bool HandleFocus [get, set]
 Starts and stops the Turntable depending on the focus and running state. More...
 
bool Caching [get, set]
 Caches the tracks if possible on/off. More...
 
bool Streaming [get, set]
 Enable or disable the streaming of audio files. More...
 
int ChunkSize [get, set]
 Size of the streaming-chunk in bytes (CT-decoder only). More...
 
int CacheStreamSize [get, set]
 Size of the cache stream in bytes (CT-decoder only). More...
 
int BufferSize [get, set]
 Size of the buffer in bytes (CT-decoder only). More...
 
bool CaptureDataStream [get, set]
 Capture the encoded PCM-stream from this player. More...
 
bool ForceInternalMP3Codec [get, set]
 Force internal MP3 codec instead of FMOD (Unity). More...
 
bool ForceInternalOGGCodec [get, set]
 Force internal OGG codec instead of FMOD (Unity). More...
 
bool InternalCodecsReadPCM [get, set]
 Read PCM data directly with the internal codecs. This is the standard behaviour for WebGL. More...
 
bool ReadDataAsStream [get, set]
 Reads the file data as stream. More...
 
AudioSource Source [get]
 AudioSource for this player. More...
 
float Position [get, set]
 Position of the current audio record in percent. More...
 
int SamplePosition [get, set]
 Position of the current audio record in samples. More...
 
float Elapsed [get, set]
 Elapsed time of the current audio record in seconds. More...
 
float Duration [get]
 Returns the duration of the current audio record in seconds. More...
 
int Samples [get]
 Returns the total samples of the current audio record. More...
 
Crosstales.DJ.Model.Enum.AudioCodec Codec [get]
 Codec of for this player. More...
 
float BufferProgress [get]
 Current buffer progress. More...
 
bool isBuffering [get]
 Is this player buffering? More...
 
bool isPlayback [get]
 Is this player in playback-mode? More...
 
bool isAudioPlaying [get]
 Is this player playing audio? More...
 
bool isPaused [get, set]
 Is this player in paused? More...
 
System.IO.Stream DataStream [get]
 Encoded PCM-stream from this player. More...
 
int Channels [get]
 Current audio channels of the current record. More...
 
int SampleRate [get]
 Current audio sample rate of the current record. 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...
 
System.Collections.Generic.List< Crosstales.DJ.Model.RecordPlayedRecords [get]
 List of all played records. More...
 

Detailed Description

Interface for all players.

Member Function Documentation

◆ Mute()

void Crosstales.DJ.IPlayer.Mute ( )

Mute the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ MuteOrUnMute()

void Crosstales.DJ.IPlayer.MuteOrUnMute ( )

Mute or unmute the playback of the record.

Implemented in Crosstales.DJ.BasePlayer.

◆ Next()

void Crosstales.DJ.IPlayer.Next ( )

Plays the next record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ Pause()

void Crosstales.DJ.IPlayer.Pause ( )

Pauses the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ PauseOrUnPause()

void Crosstales.DJ.IPlayer.PauseOrUnPause ( )

Pause or unpause the playback of the record.

Implemented in Crosstales.DJ.BasePlayer.

◆ Play()

void Crosstales.DJ.IPlayer.Play ( )

◆ PlayOrStop()

void Crosstales.DJ.IPlayer.PlayOrStop ( )

Plays or stops the record.

Implemented in Crosstales.DJ.BasePlayer.

◆ Previous()

void Crosstales.DJ.IPlayer.Previous ( )

Plays the previous record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ Restart()

void Crosstales.DJ.IPlayer.Restart ( )

Restarts the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ Stop()

void Crosstales.DJ.IPlayer.Stop ( )

Stops the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ UnMute()

void Crosstales.DJ.IPlayer.UnMute ( )

Unmute the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

◆ UnPause()

void Crosstales.DJ.IPlayer.UnPause ( )

Unpause the playback of the record.

Implemented in Crosstales.DJ.Turntable, Crosstales.DJ.SimplePlayer, and Crosstales.DJ.BasePlayer.

Property Documentation

◆ AudioData

byte [] Crosstales.DJ.IPlayer.AudioData
getset

Audio data for the current Record read outside of DJ (e.g. from the Android SAF).

◆ BufferProgress

float Crosstales.DJ.IPlayer.BufferProgress
get

Current buffer progress.

◆ BufferSize

int Crosstales.DJ.IPlayer.BufferSize
getset

Size of the buffer in bytes (CT-decoder only).

◆ CacheStreamSize

int Crosstales.DJ.IPlayer.CacheStreamSize
getset

Size of the cache stream in bytes (CT-decoder only).

◆ Caching

bool Crosstales.DJ.IPlayer.Caching
getset

Caches the tracks if possible on/off.

◆ CaptureDataStream

bool Crosstales.DJ.IPlayer.CaptureDataStream
getset

Capture the encoded PCM-stream from this player.

◆ Channels

int Crosstales.DJ.IPlayer.Channels
get

Current audio channels of the current record.

◆ ChunkSize

int Crosstales.DJ.IPlayer.ChunkSize
getset

Size of the streaming-chunk in bytes (CT-decoder only).

◆ Codec

Crosstales.DJ.Model.Enum.AudioCodec Crosstales.DJ.IPlayer.Codec
get

Codec of for this player.

◆ DataStream

System.IO.Stream Crosstales.DJ.IPlayer.DataStream
get

Encoded PCM-stream from this player.

◆ Duration

float Crosstales.DJ.IPlayer.Duration
get

Returns the duration of the current audio record in seconds.

Returns
The duration of the current audio record in seconds.

◆ Elapsed

float Crosstales.DJ.IPlayer.Elapsed
getset

Elapsed time of the current audio record in seconds.

◆ ForceInternalMP3Codec

bool Crosstales.DJ.IPlayer.ForceInternalMP3Codec
getset

Force internal MP3 codec instead of FMOD (Unity).

◆ ForceInternalOGGCodec

bool Crosstales.DJ.IPlayer.ForceInternalOGGCodec
getset

Force internal OGG codec instead of FMOD (Unity).

◆ HandleFocus

bool Crosstales.DJ.IPlayer.HandleFocus
getset

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

◆ InternalCodecsReadPCM

bool Crosstales.DJ.IPlayer.InternalCodecsReadPCM
getset

Read PCM data directly with the internal codecs. This is the standard behaviour for WebGL.

◆ isAudioPlaying

bool Crosstales.DJ.IPlayer.isAudioPlaying
get

Is this player playing audio?

Returns
True if this player is playing audio.

◆ isBuffering

bool Crosstales.DJ.IPlayer.isBuffering
get

Is this player buffering?

Returns
True if this player is buffering.

◆ isLoop

bool Crosstales.DJ.IPlayer.isLoop
getset

Loop the record on/off.

◆ isMuted

bool Crosstales.DJ.IPlayer.isMuted
getset

Is this player muted?

◆ isPaused

bool Crosstales.DJ.IPlayer.isPaused
getset

Is this player in paused?

◆ isPlayback

bool Crosstales.DJ.IPlayer.isPlayback
get

Is this player in playback-mode?

◆ Pitch

float Crosstales.DJ.IPlayer.Pitch
getset

Current pitch of this player.

◆ PlayedRecords

System.Collections.Generic.List<Crosstales.DJ.Model.Record> Crosstales.DJ.IPlayer.PlayedRecords
get

List of all played records.

◆ Position

float Crosstales.DJ.IPlayer.Position
getset

Position of the current audio record in percent.

◆ ReadDataAsStream

bool Crosstales.DJ.IPlayer.ReadDataAsStream
getset

Reads the file data as stream.

◆ Record

Crosstales.DJ.Model.Record Crosstales.DJ.IPlayer.Record
getset

Current record of this player.

◆ SamplePosition

int Crosstales.DJ.IPlayer.SamplePosition
getset

Position of the current audio record in samples.

◆ SampleRate

int Crosstales.DJ.IPlayer.SampleRate
get

Current audio sample rate of the current record.

◆ Samples

int Crosstales.DJ.IPlayer.Samples
get

Returns the total samples of the current audio record.

Returns
The total samples of the current audio record.

◆ Source

AudioSource Crosstales.DJ.IPlayer.Source
get

AudioSource for this player.

◆ StereoPan

float Crosstales.DJ.IPlayer.StereoPan
getset

Current stereo pan of this player.

◆ Streaming

bool Crosstales.DJ.IPlayer.Streaming
getset

Enable or disable the streaming of audio files.

◆ Volume

float Crosstales.DJ.IPlayer.Volume
getset

Current volume of this player.


The documentation for this interface was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/IPlayer.cs