YOyouka
Exports

Prepare a local export payload

Changed on
post/projects/{projectId}/exports/local

Request

  • Base URL
    https://api.youka.io/api/v1
  • URL
    https://api.youka.io/api/v1/projects/{projectId}/exports/local
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Headers

Idempotency-Keystring

Request body

versionIdstring
resolution'540p' | '720p' | '1080p' | '4k' required
quality'low' | 'average' | 'high' required
stemVolumesobject
playbackRatenumber
toneFrequencynumber
transparentboolean required
renderMode'standard' | 'fast' required
presetIdstring

Response

Resolved local export payload

versionIdstring required
alignmentIdstring nullable required
alignmentRevisionstring nullable required
serveUrlstring uri required
compositionIdstring required
compositionPropsobject required
durationInSecondsnumber required
aspectRatio'16:9' | '9:16' | '4:3' | '1:1' required
resolution'540p' | '720p' | '1080p' | '4k' required
quality'low' | 'average' | 'high' required
transparentboolean required
watermarkedboolean required
titlestring required
artistsstring[] required
filenamestring required

Changes

  • 3d5636b5e96dRevision changes
    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • info

      added the new optional request property /

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property

    • info

      added the new required request property /// with a default value

    • info

      added the new required request property /// with a default value

    • info

      added the new required request property //// with a default value

    • info

      added the new required request property //// with a default value

    • info

      added the new required request property //// with a default value

    • info

      added the new required request property //// with a default value

    • info

      added the new required request property ///// with a default value

    • info

      added the new required request property ///// with a default value

    • info

      added the new required request property ///// with a default value

    • info

      added the new required request property ///// with a default value

    • info

      added the new required request property //// with a default value

    • info

      added the new required request property //// with a default value

    • info

      the request property default value changed from {"fontFamily":"Arimo","fontSize":150,"fontWeight":700,"textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30} to {"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":150,"fontWeight":700,"fontStyle":"normal","textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30}

    • info

      the request property default value changed from {"enabled":true,"beats":4,"minGap":3,"useNextSingerStyle":true,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":3},"width":0.2,"height":1,"offsetX":-2,"offsetY":0} to {"enabled":true,"appearance":"classic","beats":4,"minGap":3,"useNextSingerStyle":true,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":3},"width":0.2,"fadeTailWidth":0.6,"height":1,"offsetX":-2,"offsetY":0}

    • info

      the request property default value changed from {"branding":{"logo":{"enabled":false,"position":"bottom-right","paddingX":20,"paddingY":20,"scale":0.1,"opacity":1},"intro":{"enabled":false,"durationSeconds":0,"effect":"fade","effectDuration":0.5},"outro":{"enabled":false,"durationSeconds":0,"effect":"fade","effectDuration":0.5}},"titleCard":{"enabled":true,"duration":5,"autoHideBeforeLyrics":true,"titleStyle":{"fontFamily":"Arimo","fontSize":200,"fontWeight":700,"textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30},"artistStyle":{"fontFamily":"Arimo","fontSize":150,"fontWeight":700,"textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30}},"leadIn":{"enabled":true,"beats":4,"minGap":3,"useNextSingerStyle":true,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":3},"width":0.2,"height":1,"offsetX":-2,"offsetY":0},"instrumentalBreak":{"hideLyrics":true,"minGap":5,"displayDuration":3},"breakCountdown":{"enabled":true,"maxDuration":3,"animation":"fade","useNextSingerStyle":false,"style":{"color":"#FFFFFF","outlineColor":"#000000","outlineWidth":14.5},"textSize":80,"hideBeforeEnd":0},"breakProgressBar":{"enabled":true,"maxDuration":10,"useNextSingerStyle":false,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":5,"backgroundColor":"#FFFFFF","fillColor":"#2185D0"},"width":47,"height":7.5,"position":"center","cornerRadius":0,"hideBeforeEnd":0}} to {"branding":{"logo":{"enabled":false,"position":"bottom-right","paddingX":20,"paddingY":20,"scale":0.1,"opacity":1},"intro":{"enabled":false,"durationSeconds":0,"effect":"fade","effectDuration":0.5},"outro":{"enabled":false,"durationSeconds":0,"effect":"fade","effectDuration":0.5}},"titleCard":{"enabled":true,"duration":5,"autoHideBeforeLyrics":true,"titleStyle":{"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":200,"fontWeight":700,"fontStyle":"normal","textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30},"artistStyle":{"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":150,"fontWeight":700,"fontStyle":"normal","textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30}},"leadIn":{"enabled":true,"appearance":"classic","beats":4,"minGap":3,"useNextSingerStyle":true,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":3},"width":0.2,"fadeTailWidth":0.6,"height":1,"offsetX":-2,"offsetY":0},"instrumentalBreak":{"hideLyrics":true,"minGap":5,"displayDuration":3},"breakCountdown":{"enabled":true,"maxDuration":3,"animation":"fade","useNextSingerStyle":false,"style":{"color":"#FFFFFF","outlineColor":"#000000","outlineWidth":14.5},"textSize":80,"hideBeforeEnd":0},"breakProgressBar":{"enabled":true,"maxDuration":10,"useNextSingerStyle":false,"style":{"color":"#2185D0","outlineColor":"#000000","outlineWidth":5,"backgroundColor":"#FFFFFF","fillColor":"#2185D0"},"width":47,"height":7.5,"position":"center","cornerRadius":0,"hideBeforeEnd":0}}

    • info

      the request property default value changed from {"enabled":true,"duration":5,"autoHideBeforeLyrics":true,"titleStyle":{"fontFamily":"Arimo","fontSize":200,"fontWeight":700,"textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30},"artistStyle":{"fontFamily":"Arimo","fontSize":150,"fontWeight":700,"textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30}} to {"enabled":true,"duration":5,"autoHideBeforeLyrics":true,"titleStyle":{"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":200,"fontWeight":700,"fontStyle":"normal","textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30},"artistStyle":{"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":150,"fontWeight":700,"fontStyle":"normal","textColor":"#FFFFFF","outlineColor":"#000000","outlineWidth":30}}

    • info

      the request property default value changed from {"fontFamily":"Arimo","fontSize":200,"fontWeight":700,"textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30} to {"fontFamily":"Arimo","fontSource":{"type":"catalog"},"fontSize":200,"fontWeight":700,"fontStyle":"normal","textColor":"#2185D0","outlineColor":"#000000","outlineWidth":30}

    • info

      added the new none enum value to the request property /////

    • info

      added the new none enum value to the request property /////

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status