AudioPlayerConfig

Configuration options for the audio player.

• audioUrl

  • Description: URL of the audio to be played.
  • Type: string
  • Default: None, must be provided.

• contentTier

  • Description: Content access level, indicating if the content is free, metered, or premium.
  • Type: string ('free', 'metered', 'premium')
  • Default: None, must be provided

• resourceId

  • Description: The id of the original audio file returned from the API
  • Type: string
  • Default: None, must be provided

• title

  • Description: The title displayed above the progress bar, e.g. "Listen".
  • Type: string
  • Default: "Écouter cet article"

• informationTooltip

  • Description: Flag to control the visibility of the information tooltip.
  • Type: boolean
  • Default: true

• duration

  • Description: Duration of the audio in seconds. Required if preload is disabled.
  • Type: number
  • Default: 0

• disabled

  • Description: Disables the audio player if set to true.
  • Type: boolean
  • Default: false

• sticky

  • Description: Fix the player to the bottom of the page during scrolling if the setting is enabled (true).
  • Type: boolean
  • Default: false

Ad Settings

• ad.enabled

  • Description: Controls whether ads are enabled.
  • Type: boolean
  • Default: false

• ad.channelId

  • Description: Identifier for the ads channel.
  • Type: string
  • Default: None. Must be provided if ads are enabled.

• ad.keywords

  • Description: Keywords for ad targeting purposes.
  • Type: string
  • Default: null