You've already forked RadioPlayer
mirror of
https://github.com/radio95-rnt/RadioPlayer.git
synced 2026-02-26 21:53:54 +01:00
56 lines
2.6 KiB
Python
56 lines
2.6 KiB
Python
class PlayerModule:
|
|
"""
|
|
Simple passive observer, this allows you to send the current track the your RDS encoder, or to your website
|
|
"""
|
|
def on_new_playlist(self, playlist: list[tuple[str, bool, bool, bool, dict[str, str]]]):
|
|
"""Tuple consists of the track path, to fade out, fade in, official, and args
|
|
This is called every new playlist"""
|
|
pass
|
|
def on_new_track(self, index: int, track: str, to_fade_in: bool, to_fade_out: bool, official: bool):
|
|
"""
|
|
Called on every track including the ones added by the active modifier, you can check for that comparing the playlists[index] and the track
|
|
"""
|
|
pass
|
|
class PlaylistModifierModule:
|
|
"""
|
|
Playlist modifier, this type of module allows you to shuffle, or put jingles into your playlist
|
|
"""
|
|
def modify(self, global_args: dict, playlist: list[tuple[str, bool, bool, bool, dict[str, str]]]):
|
|
"""
|
|
global_args are playlist global args (see radioPlayer_playlist_file.txt)
|
|
"""
|
|
return playlist
|
|
class PlaylistAdvisor:
|
|
"""
|
|
Only one of a playlist advisor can be loaded. This module picks the playlist file to play, this can be a scheduler or just a static file
|
|
"""
|
|
def advise(self, arguments: str | None) -> str:
|
|
"""
|
|
Arguments are the arguments passed to the program on startup
|
|
"""
|
|
return "/path/to/playlist.txt"
|
|
def new_playlist(self) -> int:
|
|
"""
|
|
Whether to play a new playlist, if this is 1, then the player will refresh, if this is two then the player will refresh quietly
|
|
"""
|
|
return 0
|
|
class ActiveModifier:
|
|
"""
|
|
This changes the next song to be played live, which means that this picks the next song, not the playlist, but this is affected by the playlist
|
|
"""
|
|
def arguments(self, arguments: str | None):
|
|
"""
|
|
Called at start up with the program arguments
|
|
"""
|
|
pass
|
|
def play(self, index:int, track: tuple[str, bool, bool, bool, dict[str, str]]) -> tuple[tuple[str, bool, bool, bool, dict[str, str]], bool] | tuple[None, None]:
|
|
"""
|
|
Returns a tuple, in the first case where a is the track and b is a bool, b corresponds to whether to extend the playlist, set to true when adding content instead of replacing it
|
|
When None, None is returned then that is treated as a skip, meaning the core will skip this song
|
|
"""
|
|
return track, False
|
|
def on_new_playlist(self, playlist: list[tuple[str, bool, bool, bool, dict[str, str]]]):
|
|
"""
|
|
Same behaviour as the basic module function
|
|
"""
|
|
pass |