Ryle Radio 1.0.0
An open-source "radio" system for Unity, allowing tracks, tuning, broadcasters, and more!
Loading...
Searching...
No Matches
RyleRadio.Tracks.IStationTrack Interface Reference

A RadioTrack that can be played as part of a station. More...

Inheritance diagram for RyleRadio.Tracks.IStationTrack:

Properties

bool IsInStation [get, set]
 Whether or not this track is part of a station.
Properties inherited from RyleRadio.Tracks.IRadioTrack
float SampleRate [get, set]
 The samples per second of this track right now. Can be changed at runtime, e.g: StationRadioTrack.
int SampleCount [get, set]
 The total number of samples in this track right now. Can be changed at runtime, e.g: StationRadioTrack.

Additional Inherited Members

Public Member Functions inherited from RyleRadio.Tracks.IRadioTrack
void Init ()
 Initializes this track.
float GetSample (int _sampleIndex)
 Get a sample at the provided index. This is the core method of a track- whatever you return here defines the audio that the track will play when selected.
virtual void AddToPlayerEndCallback (ref Action< RadioTrackPlayer > _callback)
 Update a RadioTrackPlayer when this current track ends. Used in StationRadioTrack.

Detailed Description

A RadioTrack that can be played as part of a station.

This may end up being useless in future if all tracks can be used as part of a station- currently only other StationRadioTrack s don't have this (so you can't nest stations) but that could be changed in future.

public class MyCustomTrack : RadioTrack, IStationTrack { ... }
A track to play as part of a radio. These are the fundamental objects that define the content of the ...
Definition RadioTrack.cs:20
A RadioTrack that can be played as part of a station.

Definition at line 10 of file IStationTrack.cs.

Property Documentation

◆ IsInStation

bool RyleRadio.Tracks.IStationTrack.IsInStation
getset

Whether or not this track is part of a station.

Implemented in RyleRadio.Tracks.ClipRadioTrack, and RyleRadio.Tracks.ProceduralRadioTrack.

Definition at line 15 of file IStationTrack.cs.


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