jellyfin-web/src/components/syncPlay/core/Controller.js

/**
 * Module that exposes SyncPlay calls to external modules.
 * @module components/syncPlay/core/Controller
 */

import * as Helper from './Helper';

/**
 * Class that exposes SyncPlay calls to external modules.
 */
class Controller {
    constructor() {
        this.manager = null;
    }

    /**
     * Initializes the controller.
     * @param {Manager} syncPlayManager The SyncPlay manager.
     */
    init(syncPlayManager) {
        this.manager = syncPlayManager;
    }

    /**
     * Toggles playback status in SyncPlay group.
     */
    playPause() {
        if (this.manager.isPlaying()) {
            this.pause();
        } else {
            this.unpause();
        }
    }

    /**
     * Unpauses playback in SyncPlay group.
     */
    unpause() {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayUnpause();
    }

    /**
     * Pauses playback in SyncPlay group.
     */
    pause() {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayPause();

        // Pause locally as well, to give the user some little control.
        const playerWrapper = this.manager.getPlayerWrapper();
        playerWrapper.localPause();
    }

    /**
     * Seeks playback to specified position in SyncPlay group.
     * @param {number} positionTicks The position.
     */
    seek(positionTicks) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlaySeek({
            PositionTicks: positionTicks
        });
    }

    /**
     * Starts playback in SyncPlay group.
     * @param {Object} options The play data.
     */
    play(options) {
        const apiClient = this.manager.getApiClient();
        const sendPlayRequest = (items) => {
            const queue = items.map(item => item.Id);
            return apiClient.requestSyncPlaySetNewQueue({
                PlayingQueue: queue,
                PlayingItemPosition: options.startIndex ? options.startIndex : 0,
                StartPositionTicks: options.startPositionTicks ? options.startPositionTicks : 0
            });
        };

        if (options.items) {
            return Helper.translateItemsForPlayback(apiClient, options.items, options).then(sendPlayRequest);
        } else {
            return Helper.getItemsForPlayback(apiClient, {
                Ids: options.ids.join(',')
            }).then(function (result) {
                return Helper.translateItemsForPlayback(apiClient, result.Items, options).then(sendPlayRequest);
            });
        }
    }

    /**
     * Sets current playing item in SyncPlay group.
     * @param {string} playlistItemId The item playlist identifier.
     */
    setCurrentPlaylistItem(playlistItemId) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlaySetPlaylistItem({
            PlaylistItemId: playlistItemId
        });
    }

    /**
     * Clears the playlist of a SyncPlay group.
     * @param {Array} clearPlayingItem Whether to remove the playing item as well.
     */
    clearPlaylist(clearPlayingItem = false) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayRemoveFromPlaylist({
            ClearPlaylist: true,
            ClearPlayingItem: clearPlayingItem
        });
    }

    /**
     * Removes items from SyncPlay group playlist.
     * @param {Array} playlistItemIds The items to remove.
     */
    removeFromPlaylist(playlistItemIds) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayRemoveFromPlaylist({
            PlaylistItemIds: playlistItemIds
        });
    }

    /**
     * Moves an item in the SyncPlay group playlist.
     * @param {string} playlistItemId The item playlist identifier.
     * @param {number} newIndex The new position.
     */
    movePlaylistItem(playlistItemId, newIndex) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayMovePlaylistItem({
            PlaylistItemId: playlistItemId,
            NewIndex: newIndex
        });
    }

    /**
     * Adds items to the SyncPlay group playlist.
     * @param {Object} options The items to add.
     * @param {string} mode The queue mode, optional.
     */
    queue(options, mode = 'Queue') {
        const apiClient = this.manager.getApiClient();
        if (options.items) {
            Helper.translateItemsForPlayback(apiClient, options.items, options).then((items) => {
                const itemIds = items.map(item => item.Id);
                apiClient.requestSyncPlayQueue({
                    ItemIds: itemIds,
                    Mode: mode
                });
            });
        } else {
            Helper.getItemsForPlayback(apiClient, {
                Ids: options.ids.join(',')
            }).then(function (result) {
                Helper.translateItemsForPlayback(apiClient, result.Items, options).then((items) => {
                    const itemIds = items.map(item => item.Id);
                    apiClient.requestSyncPlayQueue({
                        ItemIds: itemIds,
                        Mode: mode
                    });
                });
            });
        }
    }

    /**
     * Adds items to the SyncPlay group playlist after the playing item.
     * @param {Object} options The items to add.
     */
    queueNext(options) {
        this.queue(options, 'QueueNext');
    }

    /**
     * Plays next item from playlist in SyncPlay group.
     */
    nextItem() {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayNextItem({
            PlaylistItemId: this.manager.getQueueCore().getCurrentPlaylistItemId()
        });
    }

    /**
     * Plays previous item from playlist in SyncPlay group.
     */
    previousItem() {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlayPreviousItem({
            PlaylistItemId: this.manager.getQueueCore().getCurrentPlaylistItemId()
        });
    }

    /**
     * Sets the repeat mode in SyncPlay group.
     * @param {string} mode The repeat mode.
     */
    setRepeatMode(mode) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlaySetRepeatMode({
            Mode: mode
        });
    }

    /**
     * Sets the shuffle mode in SyncPlay group.
     * @param {string} mode The shuffle mode.
     */
    setShuffleMode(mode) {
        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlaySetShuffleMode({
            Mode: mode
        });
    }

    /**
     * Toggles the shuffle mode in SyncPlay group.
     */
    toggleShuffleMode() {
        let mode = this.manager.getQueueCore().getShuffleMode();
        mode = mode === 'Sorted' ? 'Shuffle' : 'Sorted';

        const apiClient = this.manager.getApiClient();
        apiClient.requestSyncPlaySetShuffleMode({
            Mode: mode
        });
    }
}

export default Controller;