Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseMusicXmlPlayerSyncOptions

    interface UseMusicXmlPlayerSyncOptions {
        allowUnverifiedPresenter?: boolean;
        enabled: boolean;
        fileId: string;
        isPresenter: boolean;
        localUserId: string;
        onError?: (error: Error) => void;
        onRemoteCommand: (command: MusicXmlPlayerCommand) => void;
        presenterId?: string;
    }
    Index

    Properties

    allowUnverifiedPresenter? enabled fileId isPresenter localUserId onError? onRemoteCommand presenterId?

    Properties

    allowUnverifiedPresenter?: boolean

    Apply commands from any sender while presenterId is empty. Any participant can then drive every follower's player, so leave this off unless every participant is trusted.

    false
    enabled: boolean

    Whether sync is on. For the presenter this is "share my actions"; for a follower, "follow the presenter".

    fileId: string

    Identifies the open score. Commands for a different score are ignored, so use the same id on every client.

    isPresenter: boolean

    True for the one participant whose actions everyone else follows.

    localUserId: string

    The local user's id, as the relay knows it.

    onError?: (error: Error) => void

    Called when a published command could not be delivered.

    onRemoteCommand: (command: MusicXmlPlayerCommand) => void

    Called with each command a follower should apply to its player.

    presenterId?: string

    The presenter's user id. A follower applies a command only when its sender matches. Until this is known, followers ignore every command, unless UseMusicXmlPlayerSyncOptions.allowUnverifiedPresenter is set.

    Settings

    Member Visibility

    On This Page

    Properties