Captions

จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
หมายเหตุ: เมื่อวันที่ 5 สิงหาคม 2022 YouTube ได้ประกาศว่ามีการเปลี่ยนแปลงวิธีการสร้างรหัสคําบรรยาย และเป็นส่วนหนึ่งของการเปลี่ยนแปลงดังกล่าว นั่นคือการกําหนดรหัสคําบรรยายวิดีโอใหม่ให้กับแทร็กคําบรรยายวิดีโอทั้งหมด ดูรายละเอียดเพิ่มเติมในประวัติการแก้ไข API

ทรัพยากร caption แสดงถึงแทร็กคําบรรยายวิดีโอ YouTube แทร็กคําบรรยายเชื่อมโยงกับวิดีโอ YouTube รายการเดียว

วิธีการ

API รองรับวิธีต่อไปนี้สําหรับทรัพยากร captions รายการ

list
ดึงข้อมูลรายการแทร็กคําบรรยายวิดีโอที่เชื่อมโยงกับวิดีโอที่ระบุ โปรดทราบว่าการตอบกลับ API ไม่มีคําบรรยายวิดีโอจริง และวิธี captions.download ช่วยให้เรียกดูแทร็กคําบรรยายวิดีโอได้ ลองใช้เลย
แทรก
อัปโหลดแทร็กคําบรรยายวิดีโอ
อัปเดต
อัปเดตแทร็กคําบรรยายวิดีโอ เมื่ออัปเดตแทร็กคําบรรยายวิดีโอ คุณสามารถเปลี่ยนสถานะแบบร่างของแทร็กได้ อัปโหลดไฟล์คําบรรยายวิดีโอใหม่สําหรับแทร็ก หรือทั้ง 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
ชื่อของแทร็กคําบรรยายวิดีโอ ชื่อนี้มีไว้เพื่อให้ผู้ใช้เห็นเป็นตัวเลือกในระหว่างการเล่น
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 - ไม่รองรับรูปแบบของแทร็กคําบรรยายวิดีโอ