Turntable for an audio record. More...
Public Member Functions | |
| void | Play (Record _record) |
| Plays the given record. More... | |
| override void | Play () |
| Plays the record. More... | |
| void | Cache (Record _record) |
| Caches the given record. More... | |
| void | Cache () |
| Caches the record. More... | |
| override void | Next () |
| Plays the next record. Note: calling 'Next' on the Turntable just plays the current record since it doesn't have any knowledge about other records. Please use the SimplePlayer instead. More... | |
| override void | Previous () |
| Plays the previous record. Note: calling 'Previous' on the Turntable just plays the current record since it doesn't have any knowledge about other records. Please use the SimplePlayer instead. More... | |
| override void | Pause () |
| Pauses the playback of the record. More... | |
| override void | UnPause () |
| Unpause the playback of the record. More... | |
| override void | Stop () |
| Stops the playback of the record. More... | |
| override void | Restart () |
| Restarts the playback of the record. More... | |
| override void | Mute () |
| Mute the playback of the record. More... | |
| override void | UnMute () |
| Unmute the playback of the record. More... | |
| override string | ToString () |
| void | PlayInEditor (int channels=2, int sampleRate=44100) |
| Plays the audio record (Editor only). More... | |
Public Member Functions inherited from Crosstales.DJ.BasePlayer | |
| virtual void | PlayOrStop () |
| Plays or stops the record. More... | |
| virtual void | PauseOrUnPause () |
| Pause or unpause the playback of the record. More... | |
| virtual void | MuteOrUnMute () |
| Mute or unmute the playback of the record. More... | |
Public Attributes | |
| override float | Duration => Record?.Duration ?? 0f |
| override int | Channels => Record?.Channels ?? 0 |
| override int | SampleRate => Record?.SampleRate ?? 0 |
| override bool | isPlayback => playback |
| override bool | isBuffering => !bufferAvailable |
| override System.Collections.Generic.List< Record > | PlayedRecords => playedRecords |
| Crosstales.DJ.PlaybackStartEvent | OnPlaybackStarted |
| Crosstales.DJ.PlaybackEndEvent | OnPlaybackEnded |
| Crosstales.DJ.AudioStartEvent | OnAudioStarted |
| Crosstales.DJ.AudioEndEvent | OnAudioEnded |
| Crosstales.DJ.ErrorEvent | OnError |
Protected Member Functions | |
| void | killWorker () |
| override void | onPlaybackStart (Record _record) |
| override void | onPlaybackEnd (Record _record) |
| override void | onAudioStart (Record _record) |
| override void | onAudioEnd (Record _record) |
| virtual void | onCached (Record _record) |
Protected Member Functions inherited from Crosstales.DJ.BasePlayer | |
| virtual void | onBufferingStart (Record record) |
| virtual void | onBufferingEnd (Record record) |
| virtual void | onBufferingProgressUpdate (Record record, float progress) |
| virtual void | onLoopPositionReached (Record record, LoopPoint lp) |
| virtual void | onAudioPlayTimeUpdate (Record record, float playtime) |
| virtual void | onErrorInfo (Record record, string info) |
Protected Attributes | |
| override Crosstales.DJ.PlaybackStartEvent | onPlaybackStarted => OnPlaybackStarted |
| override Crosstales.DJ.PlaybackEndEvent | onPlaybackEnded => OnPlaybackEnded |
| override Crosstales.DJ.AudioStartEvent | onAudioStarted => OnAudioStarted |
| override Crosstales.DJ.AudioEndEvent | onAudioEnded => OnAudioEnded |
| override Crosstales.DJ.ErrorEvent | onError => OnError |
Properties | |
| static Turntable | Instance [get] |
| Returns the singleton instance of this class. More... | |
| override Record | Record [get, set] |
| bool | PlayOnStart [get, set] |
| Play the Turntable on start on/off. More... | |
| float | Delay [get, set] |
| Delay in seconds until the Turntable starts playing. More... | |
| override byte[] | AudioData [get, set] |
| System.Collections.Generic.Dictionary< string, string > | RequestHeaders = new System.Collections.Generic.Dictionary<string, string>() [get] |
| HTTP-request headers for the connection to the current server (e.g. authentication). More... | |
| override bool | HandleFocus [get, set] |
| override bool | Caching [get, set] |
| override bool | Streaming [get, set] |
| override int | ChunkSize [get, set] |
| summmary>Automatically set the size of the cache stream (CT-decoder only).</summmary> | |
| bool | UseAutomaticCacheStreamSize [get, set] |
| override int | CacheStreamSize [get, set] |
| summmary>Automatically set the size of the cache stream (CT-decoder only).</summmary> | |
| bool | UseAutomaticBufferSize [get, set] |
| override int | BufferSize [get, set] |
| override bool | CaptureDataStream [get, set] |
| override bool | ForceInternalMP3Codec [get, set] |
| override bool | ForceInternalOGGCodec [get, set] |
| override bool | InternalCodecsReadPCM [get, set] |
| override bool | ReadDataAsStream [get, set] |
| override bool | isLoop [get, set] |
| override AudioSource | Source [get, protected set] |
| override float? | Position [get, set] |
| override int??? | SamplePosition [get, set] |
| override float?? | Elapsed [get, set] |
| override int | Samples [get] |
| override AudioCodec | Codec [get, protected set] |
| override float | BufferProgress [get, protected set] |
| override bool | isAudioPlaying [get, protected set] |
| override bool | isPaused [get, set] |
| override System.IO.Stream | DataStream [get, protected set] |
| override float? | Volume [get, set] |
| override float? | Pitch [get, set] |
| override float? | StereoPan [get, set] |
| override bool | isMuted [get, set] |
| static Texture2D | CoverTexture [get] |
Properties inherited from Crosstales.DJ.BasePlayer | |
| static int? | playCounter [get, set] |
| static int? | audioCounter [get, set] |
| abstract PlaybackStartEvent | onPlaybackStarted [get] |
| abstract PlaybackEndEvent | onPlaybackEnded [get] |
| abstract AudioStartEvent | onAudioStarted [get] |
| abstract AudioEndEvent | onAudioEnded [get] |
| abstract ErrorEvent | onError [get] |
| abstract Record | Record [get, set] |
| An event triggered whenever all providers are ready. More... | |
| abstract bool | isLoop [get, set] |
| abstract byte[] | AudioData [get, set] |
| abstract bool | HandleFocus [get, set] |
| abstract bool | Caching [get, set] |
| abstract bool | Streaming [get, set] |
| abstract int | ChunkSize [get, set] |
| abstract int | CacheStreamSize [get, set] |
| abstract int | BufferSize [get, set] |
| abstract bool | CaptureDataStream [get, set] |
| abstract bool | ForceInternalMP3Codec [get, set] |
| abstract bool | ForceInternalOGGCodec [get, set] |
| abstract bool | InternalCodecsReadPCM [get, set] |
| abstract bool | ReadDataAsStream [get, set] |
| abstract AudioSource | Source [get, protected set] |
| abstract float | Position [get, set] |
| abstract int | SamplePosition [get, set] |
| abstract float | Elapsed [get, set] |
| abstract float | Duration [get] |
| abstract int | Samples [get] |
| abstract Crosstales.DJ.Model.Enum.AudioCodec | Codec [get, protected set] |
| abstract float | BufferProgress [get, protected set] |
| abstract bool | isBuffering [get] |
| abstract bool | isPlayback [get] |
| abstract bool | isAudioPlaying [get, protected set] |
| abstract bool | isPaused [get, set] |
| abstract System.IO.Stream | DataStream [get, protected set] |
| abstract int | Channels [get] |
| abstract int | SampleRate [get] |
| abstract float | Volume [get, set] |
| abstract float | Pitch [get, set] |
| abstract float | StereoPan [get, set] |
| abstract bool | isMuted [get, set] |
| abstract System.Collections.Generic.List< Record > | PlayedRecords [get] |
Properties inherited from Crosstales.DJ.IPlayer | |
| 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.Record > | PlayedRecords [get] |
| List of all played records. More... | |
Events | |
| Crosstales.DJ.Cached | OnCached |
| An event triggered whenever an audio record is cached. More... | |
Events inherited from Crosstales.DJ.BasePlayer | |
| PlaybackStart | OnPlaybackStart |
| An event triggered whenever the playback starts. More... | |
| PlaybackEnd | OnPlaybackEnd |
| An event triggered whenever the playback ends. More... | |
| BufferingStart | OnBufferingStart |
| An event triggered whenever the buffering starts. More... | |
| BufferingEnd | OnBufferingEnd |
| An event triggered whenever the buffering ends. More... | |
| BufferingProgressUpdate | OnBufferingProgressUpdate |
| An event triggered whenever the buffering progress changes. More... | |
| AudioStart | OnAudioStart |
| An event triggered whenever the audio starts. More... | |
| AudioEnd | OnAudioEnd |
| An event triggered whenever the audio ends. More... | |
| LoopPositionReached | OnLoopPositionReached |
| An event triggered whenever the audio loops. More... | |
| AudioPlayTimeUpdate | OnAudioPlayTimeUpdate |
| An event triggered whenever the audio playtime changes. More... | |
| ErrorInfo | OnErrorInfo |
| An event triggered whenever an error occurs. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from Crosstales.DJ.BasePlayer | |
| static bool | isAnyPlayback => playCounter > 0 |
| Checks if any Turntable is in playback-mode on this system. More... | |
| static bool | isAnyAudioPlaying => audioCounter > 0 |
| Checks if ANY Turntable playing audio on this system. More... | |
Detailed Description
Turntable for an audio record.
Member Function Documentation
◆ Cache() [1/2]
| void Crosstales.DJ.Turntable.Cache | ( | ) |
Caches the record.
◆ Cache() [2/2]
| void Crosstales.DJ.Turntable.Cache | ( | Record | _record | ) |
Caches the given record.
- Parameters
-
_record Record to play.
◆ Mute()
|
virtual |
Mute the playback of the record.
Implements Crosstales.DJ.BasePlayer.
◆ Next()
|
virtual |
Plays the next record. Note: calling 'Next' on the Turntable just plays the current record since it doesn't have any knowledge about other records. Please use the SimplePlayer instead.
Implements Crosstales.DJ.BasePlayer.
◆ Pause()
|
virtual |
Pauses the playback of the record.
Implements Crosstales.DJ.BasePlayer.
◆ Play() [1/2]
|
virtual |
Plays the record.
Implements Crosstales.DJ.BasePlayer.
◆ Play() [2/2]
| void Crosstales.DJ.Turntable.Play | ( | Record | _record | ) |
Plays the given record.
- Parameters
-
_record Record to play.
◆ PlayInEditor()
| void Crosstales.DJ.Turntable.PlayInEditor | ( | int | channels = 2, |
| int | sampleRate = 44100 |
||
| ) |
Plays the audio record (Editor only).
◆ Previous()
|
virtual |
Plays the previous record. Note: calling 'Previous' on the Turntable just plays the current record since it doesn't have any knowledge about other records. Please use the SimplePlayer instead.
Implements Crosstales.DJ.BasePlayer.
◆ Restart()
|
virtual |
Restarts the playback of the record.
Implements Crosstales.DJ.BasePlayer.
◆ Stop()
|
virtual |
Stops the playback of the record.
Implements Crosstales.DJ.BasePlayer.
◆ UnMute()
|
virtual |
Unmute the playback of the record.
Implements Crosstales.DJ.BasePlayer.
◆ UnPause()
|
virtual |
Unpause the playback of the record.
Implements Crosstales.DJ.BasePlayer.
Property Documentation
◆ Delay
|
getset |
Delay in seconds until the Turntable starts playing.
◆ Instance
|
staticget |
Returns the singleton instance of this class.
- Returns
- Singleton instance of this class.
◆ PlayOnStart
|
getset |
Play the Turntable on start on/off.
◆ RequestHeaders
|
get |
HTTP-request headers for the connection to the current server (e.g. authentication).
Event Documentation
◆ OnCached
| Crosstales.DJ.Cached Crosstales.DJ.Turntable.OnCached |
An event triggered whenever an audio record is cached.
The documentation for this class was generated from the following file:
- C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/Turntable.cs
Public Member Functions inherited from