6.4 KiB
| title | description |
|---|---|
| Audio assets | Explore how to find and import audio assets for use in your experiences. |
You can find a wide variety of free‑to‑use audio assets in the Creator Store, or you can import audio assets that you're certain you have permission to use, such as audio that you make yourself. The asset privacy system automatically ensures that the IDs of your imported audio can't be accessed by users without proper permissions.
Find audio
The Creator Store tab of the Toolbox contains a wide variety of free-to-use audio assets made by Roblox and the Roblox community for creators to use within their experiences, including more than 100,000 professionally-produced sound effects and music tracks from top audio and music partners.
To find audio assets on the Creator Store:
-
In the Toolbox, navigate to the Creator Store tab, then use the category selector dropdown to select Audio.
-
Use the keyword search, quick filter options, and/or advanced filters to narrow down the results.
-
Right-click any audio asset, then select Copy Asset ID to copy the asset ID to your clipboard. You can now paste this asset ID into a
Class.AudioPlayerobject to play the audio.
Import audio
You can import custom audio through the Asset Manager, Creator Dashboard, and Open Cloud API as long as your audio meets the following requirements:
- You have the legal rights to that audio asset.
- It adheres to the Community Rules and Terms of Use.
- It's a single track/stream in either
.mp3,.ogg,.wavor.flacformat. - It's less than 20 MB in size and 7 minutes in duration.
- Its sample rate is less than or equal to 48 kHz.
- Its channels are set to mono or stereo 2.0, 3.0, or 5.1 surround.
If you're ID verified, you can import 100 free audio assets per 30 days; if you're unverified, you can import 10 free audio assets per 30 days. Studio assigns each new audio asset a unique asset ID that you can use within your experiences to play the audio.
To import audio through the Asset Manager:
-
Click the Import button.
-
Select and then confirm the audio files you want to import from your local system.
-
Once you confirm the imports and the files import successfully, they display with a green checkmark and a completed status.
To standardize the playback format and check for corrupt or invalid files, Studio transcodes imported audio before saving it as an asset. If you receive an error while importing audio, Studio is likely rejecting it during the transcode process. In addition, some older audio tools generate invalid file headers or frames when exporting.If Studio continues to reject the audio you're trying to import, ensure your audio tools are updated, then verify that the audio files meet the import requirements.
To import audio through the Creator Dashboard:
- In the horizontal navigation, select Development Items. All assets you have previously imported display within their respective category.
- In the sub-horizontal navigation, select Audio.
- Click the Upload Asset button. The Upload Asset page displays.
- In the Upload Asset page,
- Click the Upload button, then select and then confirm the audio file you want to import from your local system.
- Fill out the Name and Description fields with the audio file's relevant information.
- At the bottom of the page, click the Upload button.
Your audio assets are now within the moderation queue and are only visible to you within the Audio tab of the Creator Dashboard's Development Items page.
To import audio through an HTTP request:
-
Copy the API key to the
x-api-keyrequest header of the Create Asset endpoint. -
In your request:
- Specify that the target asset type is Audio.
- Add your audio asset's name and description.
- Add the creator information.
- If you want to create the audio asset on your own behalf, add your user ID. You can find your user ID on the URL of your Roblox profile. For example, for
https://www.roblox.com/users/1234567/profile, your user ID is1234567. - If you want to create the audio asset as a group asset, add the group ID of your group. You can find the group ID on the URL of your group's page. For example, for
https://www.roblox.com/groups/7654321/example-group#!/, the group ID is7654321.
- If you want to create the audio asset on your own behalf, add your user ID. You can find your user ID on the URL of your Roblox profile. For example, for
- Add the file path and content type of your asset.
curl --location 'https://apis.roblox.com/assets/v1/assets' \ --header 'x-api-key: ${ApiKey}' \ --form 'request="{ \"assetType\": \"Audio\", \"displayName\": \"Name\", \"description\": \"This is a description\", \"creationContext\": { \"creator\": { \"userId\": \"${userId}\" # Use groupId for creating a group asset } } }"' \ --form 'fileContent=@"/filepath/audio.mp3";type=audio/mpeg'
After the audio assets pass moderation, you can reuse them in any project on the platform. Although you are initially the only one who can view and use private audio assets, the asset privacy system lets you grant usage permissions to specific connections and experiences.