Show navigation ≫
≪ Hide navigation
Objects > Audio

Description

Defines an audio file to be reproduces considering multiple bitrates and formats for different devices.

Structure

Optional parameters are indicated as "(Optional)".

Parameter Meaning Notes
url (string) The url of the audio file.
bitrate (integer) (optional) The bit rate of the audio file in kbps.
  • If no bit rate is specified, Connected Web parsers will maybe not include the audio on mobile devices.
type (string) (optional) The mime type of the audio file.
  • If no type is specified, Connected Web parsers will maybe not include the audio file.
  • Mime type helps Connected Web readers to decide which kind of player is necessary to reproduce the audio file.
size (integer) (optional) The size of the audio file, in bytes.
  • If no size is specified, Connected Web readers will maybe not include the audio on mobile devices to save data.
title (string) (optional) The plain text title of the audio file.
author (author_object) (optional) The author/artist of the audio file.
  • This parameter requires a Connected Web Author Object. See the Objects > Author documentation to understand more.
description (string) (optional) The plain text description of the audio file.
bitrates (associatvie array of media_versions_objects) (optional) The audio file available in other bitrates.
  • If the audio file is already available in other bit rates, it's possibile to specify them in an associative array of versions. Each key of the array is the bit rate of the compressed audio file.
  • This parameter requires a Connected Web Media Versions Object. See the Objects > Media Versions documentation to understand more.
Continue to the Media Versions Object definition

Example

{

    "url": "https://fbwcdn.com/audio/main/connectedweb/showcase/audio1.mp3",
    "bitrate": 160,
    "type": "audio/mp3",
    "size": 8571093,
    "title": "Example Soundtrack",
    "author": {
        "name": "Enrico Tosi"
    },

}
Show navigation ≫
≪ Hide navigation