หน้านี้ได้รับการแปลโดย Cloud Translation API

Captions

หมายเหตุ: เมื่อวันที่ 13 มีนาคม 2024 YouTube ได้ประกาศว่า กำลังเลิกใช้งานพารามิเตอร์ sync สำหรับ captions.insert และ ปลายทาง API captions.update โดยการซิงค์คำบรรยายแทนเสียงอัตโนมัติยังคงใช้งานได้ใน YouTube Creator Studio โปรดดู ประวัติการแก้ไข API สำหรับ รายละเอียดเพิ่มเติม

ทรัพยากร caption แสดงแทร็กคำบรรยายของ YouTube แทร็กคำบรรยายแทนเสียงจะเชื่อมโยงกับวิดีโอ YouTube เพียง 1 รายการเท่านั้น

เมธอด

API รองรับเมธอดต่อไปนี้สำหรับทรัพยากร captions

list: เรียกดูรายการแทร็กคำบรรยายที่เชื่อมโยงกับวิดีโอที่ระบุ โปรดทราบว่าการตอบกลับของ API ไม่มีคำบรรยายแทนเสียงจริงและเมธอด captions.download จะให้คุณเรียกแทร็กคำบรรยายแทนเสียงได้ ลองใช้เลย
แทรก: อัปโหลดแทร็กคำบรรยาย
update: อัปเดตแทร็กคำบรรยาย เมื่ออัปเดตแทร็กคำบรรยายแทนเสียง คุณจะเปลี่ยนสถานะฉบับร่างของแทร็ก อัปโหลดไฟล์คำบรรยายแทนเสียงใหม่สำหรับแทร็ก หรือทั้ง 2 อย่างก็ได้
ลบ: ลบแทร็กคำบรรยายแทนเสียงที่ระบุ ลองใช้เลย
ดาวน์โหลด: ดาวน์โหลดแทร็กคำบรรยาย แทร็กคำบรรยายจะส่งคืนในรูปแบบดั้งเดิม เว้นแต่คำขอจะระบุค่าสำหรับพารามิเตอร์ tfmt และในภาษาต้นฉบับ เว้นแต่คำขอจะระบุค่าสำหรับพารามิเตอร์ tlang

การนําเสนอทรัพยากร

โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของทรัพยากร captions

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้ระบุพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
`kind`	`string` ระบุประเภทของทรัพยากร API ค่าจะเป็น `youtube#caption`
`etag`	`etag` Etag ของทรัพยากรนี้
`id`	`string` รหัสที่ YouTube ใช้เพื่อระบุแทร็กคำบรรยายโดยไม่ซ้ำกัน
`snippet`	`object` ออบเจ็กต์ `snippet` มีรายละเอียดพื้นฐานเกี่ยวกับคำบรรยาย
`snippet.videoId`	`string` รหัสที่ YouTube ใช้เพื่อระบุวิดีโอที่เชื่อมโยงกับแทร็กคำบรรยายแทนเสียงโดยไม่ซ้ำกัน
`snippet.lastUpdated`	`datetime` วันที่และเวลาที่อัปเดตแทร็กคำบรรยายแทนเสียงครั้งล่าสุด ค่าจะอยู่ในรูปแบบ ISO 8601
`snippet.trackKind`	`string` ประเภทของแทร็กคำบรรยาย ค่าที่ถูกต้องสำหรับคุณสมบัตินี้คือ `ASR` – แทร็กคำบรรยายที่สร้างขึ้นโดยใช้การจดจำคำพูดอัตโนมัติ `forced` – แทร็กคำบรรยายที่เล่นเมื่อไม่มีการเลือกแทร็กอื่นในเพลเยอร์ ตัวอย่างเช่น วิดีโอที่แสดงภาพมนุษย์ต่างดาวพูดภาษาเอเลี่ยนอาจมีแทร็กคำบรรยายที่บังคับให้แสดงแต่คำบรรยายสำหรับภาษาเอเลี่ยนเท่านั้น `standard` – แทร็กคำบรรยายแทนเสียงปกติ นี่คือค่าเริ่มต้น
`snippet.language`	`string` ภาษาของแทร็กคำบรรยายแทนเสียง ค่าพร็อพเพอร์ตี้เป็นแท็กภาษา BCP-47
`snippet.name`	`string` ชื่อแทร็กคำบรรยายแทนเสียง ชื่อนี้มีวัตถุประสงค์เพื่อแสดงให้ผู้ใช้เห็นเป็นตัวเลือกในระหว่างการเล่น ชื่อมีความยาวได้สูงสุด 150 อักขระ
`snippet.audioTrackType`	`string` ประเภทของแทร็กเสียงที่เชื่อมโยงกับแทร็กคำบรรยาย ค่าที่ถูกต้องสำหรับคุณสมบัตินี้คือ `commentary` – แทร็กคำบรรยายจะสอดคล้องกับแทร็กเสียงอื่นที่มีคำบรรยาย เช่น คำบรรยายจากไดเรกทอรี `descriptive` – แทร็กคำบรรยายจะสอดคล้องกับแทร็กเสียงอื่นที่มีเสียงบรรยายเพิ่มเติม `primary` – แทร็กคำบรรยายจะสอดคล้องกับแทร็กเสียงหลักสำหรับวิดีโอ ซึ่งเป็นแทร็กเสียงที่เชื่อมโยงกับวิดีโอตามปกติ `unknown` – ค่าเริ่มต้น
`snippet.isCC`	`boolean` ระบุว่าแทร็กมีคำบรรยายสำหรับคนหูหนวกหรือผู้ที่มีปัญหาในการได้ยินหรือไม่ ค่าเริ่มต้นคือ `false`
`snippet.isLarge`	`boolean` ระบุว่าแทร็กคำบรรยายใช้ข้อความขนาดใหญ่สำหรับผู้ที่มีความบกพร่องทางสายตาหรือไม่ ค่าเริ่มต้นคือ `false`
`snippet.isEasyReader`	`boolean` บ่งบอกว่าแทร็กคำบรรยายมีการจัดรูปแบบสำหรับ "อ่านง่าย" หรือไม่ หมายความว่าสำหรับผู้เรียนภาษาในระดับชั้นประถมศึกษาปีที่ 3 ค่าเริ่มต้นคือ `false`
`snippet.isDraft`	`boolean` ระบุว่าแทร็กคำบรรยายแทนเสียงเป็นฉบับร่างหรือไม่ หากค่าเป็น `true` แทร็กจะไม่แสดงต่อสาธารณะ ค่าเริ่มต้นคือ `false`
`snippet.isAutoSynced`	`boolean` ระบุว่า YouTube ได้ซิงค์ข้อมูลแทร็กคำบรรยายกับแทร็กเสียงในวิดีโอหรือไม่ ค่าจะเป็น `true` หากมีการขอการซิงค์อย่างชัดเจนเมื่ออัปโหลดแทร็กคำบรรยายแทนเสียง ตัวอย่างเช่น เมื่อเรียกใช้เมธอด `captions.insert` หรือ `captions.update` คุณสามารถตั้งค่าพารามิเตอร์ `sync` เป็น `true` เพื่อสั่งให้ YouTube ซิงค์แทร็กที่อัปโหลดกับวิดีโอได้ หากค่าเป็น `false` YouTube จะใช้รหัสเวลาในแทร็กคำบรรยายแทนเสียงที่อัปโหลดเพื่อกำหนดว่าเมื่อใดควรแสดงคำบรรยายแทนเสียง
`snippet.status`	`string` สถานะของแทร็กคำบรรยาย ค่าที่ถูกต้องสำหรับคุณสมบัตินี้คือ `failed` `serving` `syncing`
`snippet.failureReason`	`string` เหตุผลที่ YouTube ไม่สามารถประมวลผลแทร็กคำอธิบายวิดีโอ พร็อพเพอร์ตี้นี้จะปรากฏเมื่อค่าของพร็อพเพอร์ตี้ `state` คือ `failed` เท่านั้น ค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้นี้คือ `processingFailed` – YouTube ไม่สามารถประมวลผลแทร็กคำอธิบายวิดีโอที่อัปโหลด `unknownFormat` – ไม่รู้จักรูปแบบแทร็กคำบรรยายแทนเสียง `unsupportedFormat` – ระบบไม่รองรับรูปแบบของแทร็กคำบรรยายแทนเสียง