Class PlayerPicksQuestion

constructor

• new PlayerPicksQuestion(
      questionCurrent: number,
      pickerId: string,
      song: {
          artist: string;
          audioURL: string;
          cover: string | null;
          hrefURL: string;
          name: string;
      },
  ): PlayerPicksQuestion

  Parameters

  • questionCurrent: number
  • pickerId: string
  • song: {
        artist: string;
        audioURL: string;
        cover: string | null;
        hrefURL: string;
        name: string;
    }

    • artist: string

      The name of the song artist.

    • audioURL: string

      A URL to the audio file of the song. Currently only audio previews from Apple Music and SoundCloud are allowed.

    • cover: string | null

      Cover URL of the song.

    • hrefURL: string

      The URL users will be redirected to when clicking.

    • name: string

      The name of the song.

  Returns PlayerPicksQuestion

pickerId

questionCount

ReadonlyquestionCurrent

getQuestionMessage

• getQuestionMessage(
      gamePhase: GamePhase,
  ): {
      correctAnswer?: {
          artist: string;
          audioURL: string;
          cover: string | null;
          hrefURL: string;
          name: string;
      };
      pickerId: string;
      questionCount: number;
      questionCurrent: number;
      questionType: "player_picks";
      startPos: number;
  }

  Returns the round message for the current phase.

  Parameters

  • gamePhase: GamePhase

    the current game phase

  Returns {
      correctAnswer?: {
          artist: string;
          audioURL: string;
          cover: string | null;
          hrefURL: string;
          name: string;
      };
      pickerId: string;
      questionCount: number;
      questionCurrent: number;
      questionType: "player_picks";
      startPos: number;
  }

  • OptionalcorrectAnswer?: {
        artist: string;
        audioURL: string;
        cover: string | null;
        hrefURL: string;
        name: string;
    }

    The correct song that was requested this round, if answer is shown.

    • artist: string

      The name of the song artist.

    • audioURL: string

      A URL to the audio file of the song. Currently only audio previews from Apple Music and SoundCloud are allowed.

    • cover: string | null

      Cover URL of the song.

    • hrefURL: string

      The URL users will be redirected to when clicking.

    • name: string

      The name of the song.

  • pickerId: string

    The picker uuid for this message

  • questionCount: number

    The amount of questions in this round.

  • questionCurrent: number

    The current question number in this round.

  • questionType: "player_picks"

  • startPos: number

    The random/user-defined audio start position index (0-2) for the current question.

    See

    RoomConfigMessageSchema.audioStartPosition

toStorage

• toStorage(): PersistedPlayerPicksQuestion

  Serializes this game to a PersistedGame object.

  Returns PersistedPlayerPicksQuestion

StaticfromStorage

• fromStorage(
      persistedQuestion: PersistedPlayerPicksQuestion,
  ): PlayerPicksQuestion

  Parameters

  • persistedQuestion: PersistedPlayerPicksQuestion

  Returns PlayerPicksQuestion