내보내기

내보내기는 프로젝트에서 카라오케 또는 가사 영상을 렌더링합니다. 기본 진입점으로 client.exports.create(...)를 사용하세요. SDK가 현재 머신에서 직접 렌더링하도록 하려면 target: "local"을 선택하고, 그렇지 않으면 기본값인 클라우드 내보내기를 사용합니다.

`client.exports.create(projectId, input, options?)`

target: "cloud" | "local"로 내보내기 대상(타깃)을 선택합니다.

const cloud = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});
// => ExportOperation

const local = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
});
// => { outputPath, fileSize, duration, ... }

관리되는 비동기 내보내기를 원하면 cloud를 사용하세요. 호출자의 머신에서 직접 렌더링하려면 local을 사용하세요.

공통 필드

Field	Type	Description
`versionId`	`string`	프로젝트 버전입니다. 기본값은 기본(Primary) 버전입니다.
`resolution`	`"540p" \| "720p" \| "1080p" \| "4k"`	출력 해상도입니다.
`quality`	`"low" \| "average" \| "high"`	인코딩 품질입니다.
`fps`	`25 \| 30 \| 60`	초당 프레임 수입니다. 기본값은 `30`입니다. 더 부드러운 움직임을 원하면 `60`을 사용하세요.
`playbackRate`	`number`	속도 배율(예: `0.9`)입니다.
`toneFrequency`	`number`	반음(semitone) 단위 피치 시프트입니다.
`transparent`	`boolean`	투명 배경으로 렌더링합니다.
`presetId`	`string`	렌더링 전에 프리셋을 적용합니다.
`stemVolumes`	`Record<string, number>`	stem id를 키로 하는 stem별 볼륨 오버라이드입니다.
`settingsOverride`	`object`	이 내보내기에만 프로젝트 설정을 패치합니다.

더 부드러운 움직임을 위해 fps: 60을 사용하세요. 클라우드 견적은 60 fps에서 1.5x 크레딧 배율이 적용됩니다. 투명 60 fps 클라우드 내보내기는 선택한 길이와 해상도가 클라우드 제한에 맞을 때 사용할 수 있습니다.

stem 볼륨 예시

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  stemVolumes: {
    vocals: 0,
    instrumental: 1,
    backing: 0.5,
  },
});

설정 오버라이드 예시

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  settingsOverride: {
    trim: { startSeconds: 5, endSeconds: 180 },
    style: {
      background: { type: "color", color: "#101010" },
    },
  },
});

전체 settingsOverride 형태는 Render settings reference를 참고하세요.

`client.exports.quote(projectId, input, options?)`

내보내기를 시작하지 않고 클라우드 내보내기에 필요한 크레딧을 견적냅니다.

const quote = await client.exports.quote("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  transparent: false,
});

console.log(quote.creditsRequired, quote.sufficientBalance);

로컬 내보내기는 호출자의 머신에서 실행되며 클라우드 내보내기 크레딧을 사용하지 않으므로, quote(...)는 클라우드 내보내기에만 해당합니다.

`client.exports.list(projectId, input?, options?)`

페이지네이션과 함께 프로젝트의 내보내기 목록을 가져옵니다.

const exports = await client.exports.list("prj_abc123", {
  page: 1,
  pageSize: 50,
});

number

페이지 번호입니다. 서버에서 기본값은 1입니다.

number

페이지 크기입니다. 기본값은 100입니다. 최대 100입니다.

`client.exports.get(exportId, options?)`

부모 프로젝트를 몰라도 ID만으로 내보내기를 가져옵니다.

const exported = await client.exports.get("exp_xyz");

로컬 내보내기

const result = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
  onProgress(progress) {
    console.log(progress.stage, progress.percent);
  },
});

console.log(result.outputPath);

로컬 렌더 도구체인이 설치되거나 검증되는 동안 업데이트를 받고 싶다면 onDependencyProgress를 사용하세요.

`client.exports.prepareLocal(projectId, body, options?)`

내보내기를 로컬에서 렌더링하는 데 필요한 준비된 페이로드를 반환합니다. @youka/remotion 또는 다른 로컬 렌더러와 통합할 때 사용하세요. 서버는 클라우드 렌더를 큐에 넣지 않고 컴포지션 입력값, 에셋 URL, 렌더 파라미터를 반환합니다.

const payload = await client.exports.prepareLocal("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});

// Hand payload off to your local renderer
await renderLocally(payload);

client.exports.prepareLocal(...)는 클라우드 렌더를 시작하지 않습니다. Youka 측에서 과금되는 컴퓨팅 리소스는 소비되지 않습니다.

내보내기 완료 대기

클라우드 내보내기는 비동기입니다. client.exports.wait(...)를 사용하세요:

const operation = await client.exports.create("prj_abc123", {
  resolution: "1080p",
});

const finalized = await client.exports.wait(operation, {
  pollIntervalMs: 3_000,
});
console.log("Download from", finalized.url);

결과 다운로드

클라우드 내보내기는 서명된 url과 함께 완료됩니다. 내장 헬퍼를 사용해 파일을 디스크로 스트리밍하세요. output은 디렉터리 또는 전체 파일 경로가 될 수 있으며, filename은 선택 사항입니다:

await client.exports.download(finalized, {
  output: "./exports",
});

다음 단계

Tasks — operation 핸들과 고급 태스크 폴링
Presets — 재사용 가능한 렌더 구성
Project settings — 프로젝트의 활성 설정 패치

버전 및 타이밍 스냅샷

client.projects.versions.list(projectId)로 버전을 나열하세요. exports.create, exports.quote, 또는 exports.prepareLocal에 versionId를 전달하세요. 스타일링은 해당 버전에 속하며, 선택된 정렬(alignment)은 프로젝트에 속합니다. 클라우드 내보내기 operation 핸들과 로컬 페이로드에는 versionId, alignmentId, alignmentRevision이 포함됩니다. 이 필드들은 컴포지션을 구성하는 데 사용된 동일한 타이밍 스냅샷을 식별합니다. 이후에 준비(preparation) 또는 내보내기를 다시 수행하면 더 최신의 편집 내용이 반영될 수 있습니다. 외부 렌더러가 정확히 그 스냅샷을 사용해야 한다면 준비된 페이로드를 저장하고, 만료된 서명된 미디어 URL을 갱신하세요. 모든 stem을 무음으로 만들려면, 프로젝트의 stem ID로 stemVolumes를 구성하되 모든 값을 0으로 설정하세요. 투명 로컬 내보내기는 MOV 컨테이너에서 ProRes 4444를 사용합니다. 무음 출력에도 오디오 스트림이 포함될 수 있습니다. 전체 내보내기 예시는 Automate lyric videos를 참고하세요.

Overview

How To

Customization

Audio

Settings

Exporting

Account

`client.exports.create(projectId, input, options?)`

공통 필드

stem 볼륨 예시

설정 오버라이드 예시

`client.exports.quote(projectId, input, options?)`

`client.exports.list(projectId, input?, options?)`

`client.exports.get(exportId, options?)`

로컬 내보내기

`client.exports.prepareLocal(projectId, body, options?)`

내보내기 완료 대기

결과 다운로드

다음 단계

버전 및 타이밍 스냅샷

​client.exports.create(projectId, input, options?)

​공통 필드

​stem 볼륨 예시

​설정 오버라이드 예시

​client.exports.quote(projectId, input, options?)

​client.exports.list(projectId, input?, options?)

​client.exports.get(exportId, options?)

​로컬 내보내기

​client.exports.prepareLocal(projectId, body, options?)

​내보내기 완료 대기

​결과 다운로드

​다음 단계

​버전 및 타이밍 스냅샷

`client.exports.create(projectId, input, options?)`

공통 필드

stem 볼륨 예시

설정 오버라이드 예시

`client.exports.quote(projectId, input, options?)`

`client.exports.list(projectId, input?, options?)`

`client.exports.get(exportId, options?)`

로컬 내보내기

`client.exports.prepareLocal(projectId, body, options?)`

내보내기 완료 대기

결과 다운로드

다음 단계

버전 및 타이밍 스냅샷