ampache_react/app/actions/webplayer.js

/**
 * These actions are actions acting on the webplayer.
 */

// Other actions
import { decrementRefCount, incrementRefCount } from "./entities";
import { i18nRecord } from "../models/i18n";


export const PLAY_PAUSE = "PLAY_PAUSE";
/**
 * Toggle play / pause for the webplayer.
 *
 * @param   playPause   [Optional] True to play, false to pause. If not given,
 *                      toggle the current state.
 *
 * @return  Dispatch a PLAY_PAUSE action.
 */
export function togglePlaying(playPause) {
    return (dispatch, getState) => {
        let newIsPlaying = false;
        if (typeof playPause !== "undefined") {
            // If we want to force a mode
            newIsPlaying = playPause;
        } else {
            // Else, just toggle
            newIsPlaying = !(getState().webplayer.isPlaying);
        }
        // Dispatch action
        dispatch({
            type: PLAY_PAUSE,
            payload: {
                isPlaying: newIsPlaying,
            },
        });
    };
}


export const STOP_PLAYBACK = "STOP_PLAYBACK";
/**
 * Stop the webplayer, clearing the playlist.
 *
 * Handle the entities store reference counting.
 *
 * @return  Dispatch a STOP_PLAYBACK action.
 */
export function stopPlayback() {
    return (dispatch, getState) => {
        // Handle reference counting
        dispatch(decrementRefCount({
            song: getState().webplayer.get("playlist").toArray(),
        }));
        // Stop playback
        dispatch ({
            type: STOP_PLAYBACK,
        });
    };
}


export const SET_PLAYLIST = "SET_PLAYLIST";
/**
 * Set a given playlist.
 *
 * Handle the entities store reference counting.
 *
 * @param   playlist    A list of song IDs.
 *
 * @return  Dispatch a SET_PLAYLIST action.
 */
export function setPlaylist(playlist) {
    // Attention, order of actions *do* matter in this method. We should first
    // set the playlist and then handle the reference counting.
    // We should first increment and then increment to avoid garbage collecting
    // items that would stay in the playlist.
    return (dispatch, getState) => {
        const oldPlaylist = getState().webplayer.get("playlist").toArray();

        // Set new playlist
        dispatch ({
            type: SET_PLAYLIST,
            payload: {
                playlist: playlist,
            },
        });

        // Handle reference counting
        dispatch(incrementRefCount({
            song: playlist,
        }));
        dispatch(decrementRefCount({
            song: oldPlaylist,
        }));
    };
}


/**
 * Play a given song, emptying the current playlist.
 *
 * Handle the entities store reference counting.
 *
 * @param   songID      The id of the song to play.
 *
 * @return  Dispatch a SET_PLAYLIST action to play this song and start playing.
 */
export function playSong(songID) {
    // Attention, order of actions *do* matter in this method. We should first
    // set the playlist and then handle the reference counting.
    // We should first increment and then increment to avoid garbage collecting
    // items that would stay in the playlist.
    return (dispatch, getState) => {
        // Get old and new playlists
        const oldPlaylist = getState().webplayer.get("playlist").toArray();

        // Set new playlist
        dispatch({
            type: SET_PLAYLIST,
            payload: {
                playlist: [songID],
            },
        });

        // Handle reference counting
        dispatch(incrementRefCount({
            song: [songID],
        }));
        dispatch(decrementRefCount({
            song: oldPlaylist,
        }));

        // Force playing
        dispatch(togglePlaying(true));
    };
}


export const PUSH_SONG = "PUSH_SONG";
/**
 * Push a given song in the playlist.
 *
 * Handle the entities store reference counting.
 *
 * @param   songID      The id of the song to push.
 * @param   index       [Optional] The position to insert at in the playlist.
 *                      If negative, counts from the end. Undefined (default)
 *                      is last position.
 *
 * @return  Dispatch a PUSH_SONG action.
 */
export function pushSong(songID, index) {
    return (dispatch) => {
        // Handle reference counting
        dispatch(incrementRefCount({
            song: [songID],
        }));
        // Push song
        dispatch({
            type: PUSH_SONG,
            payload: {
                song: songID,
                index: index,
            },
        });
    };
}


export const POP_SONG = "POP_SONG";
/**
 * Pop a given song from the playlist.
 *
 * Handle the entities store reference counting.
 *
 * @param   songID      The id of the song to pop.
 *
 * @return  Dispatch a POP_SONG action.
 */
export function popSong(songID) {
    return (dispatch) => {
        // Handle reference counting
        dispatch(decrementRefCount({
            song: [songID],
        }));
        // Pop song
        dispatch({
            type: POP_SONG,
            payload: {
                song: songID,
            },
        });
    };
}


export const JUMP_TO_SONG = "JUMP_TO_SONG";
/**
 * Set current playlist index to specific song.
 *
 * @param   songID      The id of the song to play.
 *
 * @return  Dispatch a JUMP_TO_SONG action.
 */
export function jumpToSong(songID) {
    return (dispatch) => {
        // Push song
        dispatch({
            type: JUMP_TO_SONG,
            payload: {
                song: songID,
            },
        });
    };
}


export const PLAY_PREVIOUS_SONG = "PLAY_PREVIOUS_SONG";
/**
 * Move one song backwards in the playlist.
 *
 * @return  Dispatch a PLAY_PREVIOUS_SONG action.
 */
export function playPreviousSong() {
    return (dispatch) => {
        dispatch({
            type: PLAY_PREVIOUS_SONG,
        });
    };
}


export const PLAY_NEXT_SONG = "PLAY_NEXT_SONG";
/**
 * Move one song forward in the playlist.
 *
 * @return  Dispatch a PLAY_NEXT_SONG action.
 */
export function playNextSong() {
    return (dispatch) => {
        dispatch({
            type: PLAY_NEXT_SONG,
        });
    };
}


export const TOGGLE_RANDOM = "TOGGLE_RANDOM";
/**
 * Toggle random mode.
 *
 * @return  Dispatch a TOGGLE_RANDOM action.
 */
export function toggleRandom() {
    return (dispatch) => {
        dispatch({
            type: TOGGLE_RANDOM,
        });
    };
}


export const TOGGLE_REPEAT = "TOGGLE_REPEAT";
/**
 * Toggle repeat mode.
 *
 * @return  Dispatch a TOGGLE_REPEAT action.
 */
export function toggleRepeat() {
    return (dispatch) => {
        dispatch({
            type: TOGGLE_REPEAT,
        });
    };
}


export const TOGGLE_MUTE = "TOGGLE_MUTE";
/**
 * Toggle mute mode.
 *
 * @return  Dispatch a TOGGLE_MUTE action.
 */
export function toggleMute() {
    return (dispatch) => {
        dispatch({
            type: TOGGLE_MUTE,
        });
    };
}


export const SET_VOLUME = "SET_VOLUME";
/**
 * Set the volume.
 *
 * @param   volume      Volume to set (between 0 and 100)
 *
 * @return  Dispatch a SET_VOLUME action.
 */
export function setVolume(volume) {
    return (dispatch) => {
        dispatch({
            type: SET_VOLUME,
            payload: {
                volume: volume,
            },
        });
    };
}


export const SET_ERROR = "SET_ERROR";
/**
 * Set an error in case a song is not in a supported format.
 *
 * @return  Dispatch a SET_ERROR action.
 */
export function unsupportedMediaType() {
    return (dispatch) => {
        dispatch({
            type: SET_ERROR,
            payload: {
                error: new i18nRecord({
                    id: "app.webplayer.unsupported",
                    values: {},
                }),
            },
        });
    };
}