Documentation

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
    • Set up your project
    • Unity Authentication Service in Unreal
    • Create voice and text channels
    • Messaging
    • Audio management
    • Muting
    • In-game moderation
    • Android app development
    • iOS app development
    • Server-side recording
      • Required permissions for Amazon S3 buckets
      • Subscribe API query parameters
      • Server-side recording decoder
        • Decode API query parameters
        • Make a decode request
        • Decode a subscription with different options
      • Automatically end a server-side recording subscription
      • Server-side recording API usage examples
    • Speech-to-text audio transcription
    • Text-to-speech
    • Real-time recording
    • Transmission
    • Troubleshooting
  • Tutorials
  • Reference
  1. Vivox Unreal SDK documentation

Decode API query parameters

Reference the query parameters for the server-side recording decode API.
Read time 1 minute
Last updated 8 months ago

The server-side recording /ssr/decode API uses the following request parameters.
auth_token
  • Required for all /decode requests.
  • Generated from /api/viv_signin.php.
  • For more information, refer to the Access Token Developer Guide.
destination_credentials
  • Required for all /decode requests.
  • Generated from Amazon S3.
  • Requires read and write access.
  • Uses the following format:
    {"access_key_id":"aws-access-id","secret_access_key":"aws-secret-key"}
s3_uri
  • Required for all /decode requests.
  • Generated from the /ssr/subscribe response (upload_destination).
  • Uses the following format:
    s3://bucket-name/uuid/
decode_options
  • Indicates the form that you want your final subscriptions uploaded in.
  • Uses the following options:
    • concat - Returns 1 wav file per user
    • poly - Returns 1 multi-tracked wav file with a user on each track

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.


    Report a problem with this page
    ​
    ​