YouTube Embedded Players and Player Parameters

ภาพรวม

เอกสารนี้จะอธิบายวิธีฝังโปรแกรมเล่น YouTube ในแอปพลิเคชันของคุณ และกําหนดพารามิเตอร์ที่พร้อมใช้งานในโปรแกรมเล่นแบบฝังของ YouTube

เมื่อเพิ่มพารามิเตอร์ต่อท้าย URL ของ IFrame คุณสามารถกําหนดค่าประสบการณ์การเล่นในแอปพลิเคชันของคุณได้ ตัวอย่างเช่น คุณสามารถเล่นวิดีโอโดยอัตโนมัติโดยใช้พารามิเตอร์ autoplay หรือทําให้วิดีโอเล่นซ้ําๆ โดยใช้พารามิเตอร์ loop คุณยังสามารถใช้พารามิเตอร์ enablejsapi เพื่อให้โปรแกรมเล่นควบคุมผ่าน IFrame Player API ได้ด้วย

ปัจจุบัน หน้านี้กําหนดพารามิเตอร์ทั้งหมดที่รองรับในโปรแกรมเล่นแบบฝังของ YouTube คําจํากัดความพารามิเตอร์แต่ละรายการจะระบุโปรแกรมเล่นที่รองรับพารามิเตอร์ที่เกี่ยวข้อง

หมายเหตุ: โปรแกรมเล่นที่ฝังจะต้องมีวิวพอร์ตขนาดไม่ต่ำกว่า 200px คูณ 200px หากโปรแกรมเล่นแสดงตัวควบคุม โปรแกรมเล่นต้องใหญ่พอที่จะแสดงตัวควบคุมได้อย่างสมบูรณ์โดยไม่ลดขนาดวิวพอร์ตต่ํากว่าขนาดขั้นต่ํา เราขอแนะนําให้มีโปรแกรมเล่น 16:9 ที่กว้างอย่างน้อย 480 พิกเซลและสูง 270 พิกเซล

ฝังโปรแกรมเล่น YouTube

คุณสามารถใช้วิธีการต่อไปนี้เพื่อฝังโปรแกรมเล่น YouTube ในแอปพลิเคชันของคุณและระบุพารามิเตอร์ของโปรแกรมเล่น โปรดทราบว่าคําแนะนําด้านล่างแสดงวิธีฝังโปรแกรมเล่นที่โหลดวิดีโอเพียงรายการเดียว ส่วนต่อไปนี้จะอธิบายวิธีกําหนดค่าโปรแกรมเล่นให้โหลดเพลย์ลิสต์หรือวิดีโอที่ผู้ใช้อัปโหลด

ฝังโปรแกรมเล่นโดยใช้แท็ก <iframe>

กําหนดแท็ก <iframe> ในแอปพลิเคชันที่ URL src จะระบุเนื้อหาที่ผู้เล่นจะโหลด รวมถึงพารามิเตอร์โปรแกรมเล่นอื่นๆ ที่คุณต้องการตั้งค่า พารามิเตอร์ height และ width ของแท็ก <iframe> ระบุขนาดของโปรแกรมเล่น

หากคุณสร้างองค์ประกอบ <iframe> ด้วยตนเอง (แทนที่จะใช้ IFrame Player API ในการสร้าง) คุณสามารถใส่พารามิเตอร์โปรแกรมเล่นต่อท้าย URL โดยตรง URL มีรูปแบบต่อไปนี้

https://www.youtube.com/embed/VIDEO_ID

แท็ก <iframe> ด้านล่างจะโหลดโปรแกรมเล่นขนาด 640x360 พิกเซลที่จะเปิดวิดีโอ YouTube M7lc1UVf-VE เนื่องจาก URL จะตั้งค่าพารามิเตอร์ autoplay เป็น 1 วิดีโอจะเล่นโดยอัตโนมัติเมื่อโปรแกรมเล่นวิดีโอโหลดขึ้น

<iframe id="ytplayer" type="text/html" width="640" height="360"
  src="https://www.youtube.com/embed/M7lc1UVf-VE?autoplay=1&origin=http://example.com"
  frameborder="0"></iframe>

ฝังโปรแกรมเล่นโดยใช้ IFrame Player API

ทําตามวิธีการของ IFrame Player API เพื่อแทรกโปรแกรมเล่นวิดีโอในหน้าเว็บหรือแอปพลิเคชันหลังจากที่โค้ด JavaScript ของ Player API โหลดแล้ว พารามิเตอร์ที่สองในเครื่องมือสร้างสําหรับโปรแกรมเล่นวิดีโอคือออบเจ็กต์ที่ระบุตัวเลือกโปรแกรมเล่น ภายในออบเจ็กต์ดังกล่าว พร็อพเพอร์ตี้ playerVars จะระบุพารามิเตอร์โปรแกรมเล่น

โค้ด HTML และ JavaScript ด้านล่างแสดงตัวอย่างง่ายๆ ที่จะแทรกโปรแกรมเล่น YouTube ลงในองค์ประกอบของหน้าเว็บที่มีค่า id เป็น ytplayer ระบบจะเรียกฟังก์ชัน onYouTubePlayerAPIReady() ที่ระบุไว้ที่นี่โดยอัตโนมัติเมื่อโหลดโค้ด IFrame Player API แล้ว โค้ดนี้ไม่ได้กําหนดพารามิเตอร์ใดๆ ของโปรแกรมเล่น และไม่ได้กําหนดเครื่องจัดการเหตุการณ์อื่นๆ

<div id="ytplayer"></div>

<script>
  // Load the IFrame Player API code asynchronously.
  var tag = document.createElement('script');
  tag.src = "https://www.youtube.com/player_api";
  var firstScriptTag = document.getElementsByTagName('script')[0];
  firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

  // Replace the 'ytplayer' element with an <iframe> and
  // YouTube player after the API code downloads.
  var player;
  function onYouTubePlayerAPIReady() {
    player = new YT.Player('ytplayer', {
      height: '360',
      width: '640',
      videoId: 'M7lc1UVf-VE'
    });
  }
</script>

เลือกเนื้อหาที่จะเล่น

คุณสามารถกําหนดค่าโปรแกรมเล่นแบบฝังเพื่อโหลดวิดีโอ เพลย์ลิสต์ หรือวิดีโอที่อัปโหลดของผู้ใช้

รายการต่อไปนี้จะอธิบายตัวเลือกเหล่านี้:

  • การโหลดวิดีโอ

    สําหรับการฝัง iframe รหัสวิดีโอ YouTube ของวิดีโอที่คุณต้องการโหลดจะระบุอยู่ใน URL src ของ IFrame

    https://www.youtube.com/embed/VIDEO_ID

    หากใช้ API ข้อมูลของ YouTube (v3) คุณจะสร้าง URL เหล่านี้แบบเป็นโปรแกรมได้โดยการดึงรหัสวิดีโอจากผลการค้นหา ทรัพยากรของรายการเพลย์ลิสต์ ทรัพยากรของวิดีโอ หรือทรัพยากรอื่นๆ เมื่อได้รับรหัสวิดีโอ ให้แทนที่ข้อความ VIDEO_ID ใน URL ด้านบนด้วยค่านั้นเพื่อสร้าง URL ของโปรแกรมเล่น

  • การโหลดเพลย์ลิสต์

    ตั้งค่าพารามิเตอร์โปรแกรมเล่น listType เป็น playlist นอกจากนี้ ตั้งค่าพารามิเตอร์โปรแกรมเล่น list เป็นรหัสเพลย์ลิสต์ YouTube ที่คุณต้องการโหลด

    https://www.youtube.com/embed?listType=playlist&list=PLAYLIST_ID

    โปรดทราบว่าคุณต้องแทรกรหัสเพลย์ลิสต์ไว้หน้าตัวอักษร PL ดังที่ปรากฏในตัวอย่างต่อไปนี้:

    https://www.youtube.com/embed?listType=playlist&list=PLC77007E23FF423C6

    หากใช้ API ข้อมูลของ YouTube (v3) คุณจะสร้าง URL เหล่านี้แบบเป็นโปรแกรมได้ด้วยการเรียกข้อมูลรหัสเพลย์ลิสต์จากผลการค้นหา แหล่งข้อมูลของช่อง หรือทรัพยากรกิจกรรม เมื่อได้รับรหัสเพลย์ลิสต์ ให้แทนที่ข้อความ PLAYLIST_ID ใน URL ด้านบนด้วยค่านั้น

  • การโหลดวิดีโอที่ผู้ใช้อัปโหลด

    ตั้งค่าพารามิเตอร์โปรแกรมเล่น listType เป็น user_uploads นอกจากนี้ ให้ตั้งพารามิเตอร์โปรแกรมเล่น list เป็นชื่อผู้ใช้ YouTube ซึ่งมีวิดีโอที่คุณต้องการโหลด

    https://www.youtube.com/embed?listType=user_uploads&list=USERNAME

พารามิเตอร์ที่รองรับ

พารามิเตอร์ต่อไปนี้ทั้งหมดเป็นตัวเลือก

พารามิเตอร์

autoplay

พารามิเตอร์นี้กําหนดว่าวิดีโอเริ่มต้นจะเริ่มเล่นโดยอัตโนมัติเมื่อโปรแกรมเล่นโหลดไหม ค่าที่รองรับคือ 0 หรือ 1 ค่าเริ่มต้นคือ 0

หากคุณเปิดใช้การเล่นอัตโนมัติ การเล่นจะเกิดขึ้นโดยไม่ต้องมีการโต้ตอบใดๆ กับโปรแกรมเล่น ดังนั้น การรวบรวมข้อมูลและการเล่นการเล่นจะเกิดขึ้นเมื่อมีการโหลดหน้าเว็บ

cc_lang_pref

พารามิเตอร์นี้ระบุภาษาเริ่มต้นที่โปรแกรมเล่นจะใช้เพื่อแสดงคําอธิบายภาพ ตั้งค่าของพารามิเตอร์เป็นรหัสภาษา ISO 639-1 สองตัวอักษร

หากคุณใช้พารามิเตอร์นี้และตั้งค่าพารามิเตอร์ cc_load_policy เป็น 1 โปรแกรมเล่นจะแสดงคําบรรยายในภาษาที่ระบุเมื่อโปรแกรมเล่นโหลด หากคุณยังไม่ได้ตั้งค่าพารามิเตอร์ cc_load_policy คําบรรยายจะไม่แสดงโดยค่าเริ่มต้น แต่จะแสดงในภาษาที่ระบุหากผู้ใช้เลือกเปิดคําบรรยาย

cc_load_policy

การตั้งค่าพารามิเตอร์เป็น 1 จะทําให้ระบบแสดงคําบรรยายโดยค่าเริ่มต้น แม้ว่าผู้ใช้จะปิดคําบรรยายก็ตาม ลักษณะการทํางานเริ่มต้นจะอิงตามค่ากําหนดของผู้ใช้

color

พารามิเตอร์นี้จะระบุสีที่จะใช้ในแถบความคืบหน้าของโปรแกรมเล่นวิดีโอเพื่อไฮไลต์จํานวนวิดีโอที่ผู้ชมได้ดูไปแล้ว ค่าพารามิเตอร์ที่ถูกต้องคือ red และ white และโดยค่าเริ่มต้น โปรแกรมเล่นจะใช้สีแดงในแถบความคืบหน้าของวิดีโอ ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกสีได้ในบล็อก YouTube API

controls

พารามิเตอร์นี้บ่งบอกว่าตัวควบคุมโปรแกรมเล่นวิดีโอแสดงอยู่ไหม

  • controls=0 – ตัวควบคุมโปรแกรมเล่นไม่แสดงในโปรแกรมเล่น
  • controls=1 (ค่าเริ่มต้น) – ตัวควบคุมโปรแกรมเล่นวิดีโอจะแสดงในโปรแกรมเล่น

disablekb

การตั้งค่าพารามิเตอร์เป็น 1 ทําให้โปรแกรมเล่นไม่ตอบสนองต่อการควบคุมด้วยแป้นพิมพ์ ค่าเริ่มต้นคือ 0 ซึ่งหมายความว่าการควบคุมด้วยแป้นพิมพ์จะเปิดใช้งาน การควบคุมแป้นพิมพ์ที่สนับสนุนในขณะนี้ มีดังนี้

  • Spacebar หรือ [k]: เล่น / หยุดชั่วคราว
  • ลูกศรซ้าย: ย้อนกลับไป 5 วินาทีในวิดีโอปัจจุบัน
  • ลูกศรขวา: ข้ามไปข้างหน้า 5 วินาทีในวิดีโอปัจจุบัน
  • ลูกศรขึ้น: เพิ่มระดับเสียง
  • ลูกศรลง: ลดระดับเสียง
  • [f]: สลับการแสดงผลแบบเต็มหน้าจอ
  • [j]: ย้อนกลับไป 10 วินาทีในวิดีโอปัจจุบัน
  • [l]: ข้ามไปข้างหน้า 10 วินาทีในวิดีโอปัจจุบัน
  • [m]: ปิดหรือเปิดเสียงวิดีโอ
  • [0-9]: ข้ามไปยังจุดที่ต้องการในวิดีโอ 0 ข้ามไปที่ตอนเริ่มต้นของวิดีโอ 1 ข้ามไปที่จุด 10% ของวิดีโอ 2 ข้ามไปที่จุด 20% ของวิดีโอ และอื่นๆ

enablejsapi

การตั้งค่าพารามิเตอร์เป็น 1 จะช่วยให้โปรแกรมเล่นควบคุมผ่านการเรียก API ของโปรแกรมเล่น IFrame ได้ ค่าเริ่มต้นคือ 0 ซึ่งหมายความว่าโปรแกรมเล่นจะควบคุมด้วย API ดังกล่าวไม่ได้

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับ IFrame API และวิธีใช้ โปรดดูเอกสารประกอบของ IFrame API

end

พารามิเตอร์นี้จะระบุเวลาในหน่วยวินาทีนับจากจุดเริ่มต้นของวิดีโอ ซึ่งเป็นเวลาที่โปรแกรมเล่นวิดีโอควรหยุดเล่นวิดีโอ ค่าพารามิเตอร์เป็นจํานวนเต็มบวก

โปรดทราบว่าระบบจะวัดเวลาจากจุดเริ่มต้นของวิดีโอ ไม่ใช่จากค่าพารามิเตอร์ของโปรแกรมเล่น start หรือพารามิเตอร์ startSeconds ซึ่งใช้ในฟังก์ชัน API โปรแกรมเล่นวิดีโอสําหรับการโหลดหรือจัดคิววิดีโอ

fs

การตั้งค่าพารามิเตอร์นี้เป็น 0 จะป้องกันไม่ให้ปุ่มเต็มหน้าจอแสดงในโปรแกรมเล่น ค่าเริ่มต้นคือ 1 ซึ่งทําให้ปุ่มเต็มหน้าจอแสดงขึ้น

hl

ตั้งค่าภาษาของอินเทอร์เฟซโปรแกรมเล่น ค่าพารามิเตอร์คือรหัสภาษา ISO 639-1 สองตัวอักษร หรือภาษาที่ระบุอย่างครบถ้วน เช่น fr และ fr-ca ต่างก็เป็นค่าที่ถูกต้อง โค้ดภาษาอื่นๆ ที่ป้อน เช่น แท็กภาษา IETF (BCP 47) ก็อาจได้รับการจัดการอย่างถูกต้องเช่นกัน

ภาษาอินเทอร์เฟซจะใช้สําหรับเคล็ดลับเครื่องมือในโปรแกรมเล่นวิดีโอ และจะมีผลกับแทร็กคําบรรยายเริ่มต้นด้วย โปรดทราบว่า YouTube อาจเลือกภาษาคําอธิบายภาพอื่นสําหรับผู้ใช้แต่ละคน ขึ้นอยู่กับค่ากําหนดภาษาของผู้ใช้แต่ละคนและความพร้อมให้บริการของแทร็กคําอธิบายภาพ

iv_load_policy

การตั้งค่าพารามิเตอร์เป็น 1 จะทําให้คําอธิบายประกอบวิดีโอแสดงโดยค่าเริ่มต้น ในขณะที่การตั้งค่าเป็น 3 จะทําให้คําอธิบายประกอบวิดีโอไม่แสดงโดยค่าเริ่มต้น ค่าเริ่มต้นคือ 1

list

พารามิเตอร์ list ร่วมกับพารามิเตอร์ listType จะระบุเนื้อหาที่จะโหลดในโปรแกรมเล่นวิดีโอ

  • หากค่าพารามิเตอร์ listType คือ user_uploads ค่าพารามิเตอร์ list จะระบุช่อง YouTube ที่จะมีการอัปโหลดวิดีโอ
  • หากค่าพารามิเตอร์ listType คือ playlist ค่าพารามิเตอร์ list จะระบุรหัสเพลย์ลิสต์ YouTube ในค่าพารามิเตอร์ คุณจะต้องใส่รหัสเพลย์ลิสต์ไว้ข้างหน้าด้วยตัวอักษร PL ดังที่แสดงในตัวอย่างด้านล่าง
    https://www.youtube.com/embed?
        listType=playlist
        &list=PLC77007E23FF423C6
  • หากค่าพารามิเตอร์ listType คือ search ค่าพารามิเตอร์ list จะระบุคําค้นหา หมายเหตุ: ระบบจะเลิกใช้งานฟังก์ชันนี้ตั้งแต่วันที่ 15 พฤศจิกายน 2020
หมายเหตุ: หากคุณระบุค่าสําหรับพารามิเตอร์ list และ listType แล้ว URL แบบฝังของ IFrame ไม่จําเป็นต้องระบุรหัสวิดีโอ

listType

พารามิเตอร์ listType ร่วมกับพารามิเตอร์ list จะระบุเนื้อหาที่จะโหลดในโปรแกรมเล่นวิดีโอ ค่าพารามิเตอร์ที่ถูกต้องคือ playlist และ user_uploads

หากคุณระบุค่าสําหรับพารามิเตอร์ list และ listType แล้ว URL แบบฝังของ IFrame ไม่จําเป็นต้องระบุรหัสวิดีโอ

หมายเหตุ: ระบบได้searchเลิกใช้งานค่าพารามิเตอร์รายการที่ 3 search แล้ว ตั้งแต่วันที่ 15 พฤศจิกายน 2020

loop

ในกรณีที่เป็นโปรแกรมเล่นวิดีโอเดียว การตั้งค่า 1 จะทําให้โปรแกรมเล่นวิดีโอเล่นซ้ําหลายครั้ง ในกรณีที่เป็นโปรแกรมเล่นเพลย์ลิสต์ (หรือโปรแกรมเล่นแบบกําหนดเอง) โปรแกรมเล่นวิดีโอจะเล่นทั้งเพลย์ลิสต์แล้วจึงเริ่มอีกครั้งที่วิดีโอแรก

ค่าที่รองรับคือ 0 และ 1 และค่าเริ่มต้นคือ 0

หมายเหตุ: พารามิเตอร์นี้รองรับการจํากัดการฝัง iframe เท่านั้น หากต้องการวนซ้ําวิดีโอ 1 รายการ ให้ตั้งค่าพารามิเตอร์ loop เป็น 1 และตั้งค่าพารามิเตอร์ playlist เป็นรหัสวิดีโอเดียวกันกับที่ระบุอยู่ใน URL ของ Player API ดังนี้
https://www.youtube.com/embed/VIDEO_ID?playlist=VIDEO_ID&loop=1

modestbranding

หมายเหตุ: พารามิเตอร์นี้เลิกใช้งานแล้วและไม่มีผลใดๆ โปรดดูข้อมูลเพิ่มเติมที่ประกาศการเลิกใช้งาน

origin

พารามิเตอร์นี้มีมาตรการรักษาความปลอดภัยเพิ่มเติมสําหรับ IFrame API และสนับสนุนการฝัง iframe เท่านั้น หากคุณใช้ IFrame API ซึ่งหมายความว่าคุณกําลังตั้งค่าค่าพารามิเตอร์ enablejsapi เป็น 1 คุณควรระบุโดเมนเป็นค่าพารามิเตอร์ origin เสมอ

playlist

พารามิเตอร์นี้ระบุรายการรหัสวิดีโอที่คั่นด้วยจุลภาคที่จะเล่น หากคุณระบุค่า วิดีโอแรกที่เล่นจะเป็น VIDEO_ID ที่ระบุไว้ในเส้นทาง URL และวิดีโอที่ระบุในพารามิเตอร์ playlist จะเล่นหลังจากนั้น

playsinline

พารามิเตอร์นี้จะควบคุมว่าวิดีโอจะเล่นแบบอินไลน์หรือเต็มหน้าจอบน iOS ค่าที่ใช้ได้มีดังนี้

  • 0: ผลลัพธ์การเล่นแบบเต็มหน้าจอ ปัจจุบันคือค่าเริ่มต้น แม้ว่าค่าเริ่มต้นอาจเปลี่ยนแปลงได้
  • 1: แสดงผลลัพธ์ในการเล่นอินไลน์สําหรับเบราว์เซอร์บนอุปกรณ์เคลื่อนที่และสําหรับ WebViews ที่สร้างด้วยการตั้งค่าพร็อพเพอร์ตี้ allowsInlineMediaPlayback เป็น YES

rel

หมายเหตุ: พารามิเตอร์นี้มีการเปลี่ยนแปลงในวันที่ 25 กันยายน 2018 หรือหลังจากนั้น

ก่อนการเปลี่ยนแปลงนี้ พารามิเตอร์นี้จะระบุว่าโปรแกรมเล่นควรแสดงวิดีโอที่เกี่ยวข้องเมื่อเล่นวิดีโอเริ่มต้นหรือไม่
  • หากค่าพารามิเตอร์เป็น 1 ซึ่งเป็นค่าเริ่มต้น โปรแกรมเล่นจะแสดงวิดีโอที่เกี่ยวข้อง
  • หากค่าพารามิเตอร์เป็น 0 โปรแกรมเล่นจะไม่แสดงวิดีโอที่เกี่ยวข้อง
หลังจากเปลี่ยนแปลงแล้ว คุณจะปิดใช้วิดีโอที่เกี่ยวข้องไม่ได้ แต่ถ้าตั้งค่าพารามิเตอร์ rel เป็น 0 วิดีโอที่เกี่ยวข้องจะมาจากช่องเดียวกับวิดีโอที่เพิ่งเล่น

start

พารามิเตอร์นี้ทําให้โปรแกรมเล่นวิดีโอเริ่มเล่นตามจํานวนวินาทีที่ระบุไว้ตั้งแต่ต้นของวิดีโอ ค่าพารามิเตอร์เป็นจํานวนเต็มบวก โปรดทราบว่า ฟังก์ชันนี้จะคล้ายกับคีย์เฟรม seekTo โดยโปรแกรมจะมองหาคีย์เฟรมที่ใกล้ที่สุดเป็นเวลาที่คุณระบุ ซึ่งหมายความว่าบางครั้งส่วนหัวของตัวควบคุมการเล่นอาจพยายามอยู่ก่อนเวลาที่ขอ โดยทั่วไปแล้วไม่เกิน 2 วินาที

widget_referrer

พารามิเตอร์นี้เป็นตัวระบุ URL ที่มีการฝังโปรแกรมเล่นดังกล่าว ค่านี้จะถูกนํามาใช้ในการรายงาน YouTube Analytics เมื่อโปรแกรมเล่น YouTube ถูกฝังในวิดเจ็ต จากนั้นวิดเจ็ตจะถูกฝังลงในหน้าเว็บหรือแอปพลิเคชัน ในสถานการณ์ดังกล่าว พารามิเตอร์ origin จะระบุโดเมนของผู้ให้บริการวิดเจ็ต แต่ YouTube Analytics ไม่ควรระบุผู้ให้บริการวิดเจ็ตเป็นแหล่งที่มาของการเข้าชมจริง แต่ YouTube Analytics จะใช้ค่าพารามิเตอร์ widget_referrer เพื่อระบุโดเมนที่เชื่อมโยงกับแหล่งที่มาของการเข้าชมแทน

ประวัติการแก้ไข

August 15, 2023

Note: This is a deprecation announcement for the modestbranding parameter.

The modestbranding parameter is deprecated and will have no effect. To align with YouTube's branding requirements, the player now determines the appropriate branding treatment based on a combination of factors, including player size, other API parameters (e.g. controls), and additional signals.

April 27, 2021

The playsinline parameter definition has been updated slightly to explain that the parameter pertains to both mobile browsers on iOS and iOS WebViews.

October 15, 2020

The autoplay parameter definition has been updated to explain that if you enable Autoplay, playback will occur without any user interaction with the player; playback data collection and sharing will therefore occur upon page load.

October 13, 2020

Note: This is a deprecation announcement for the embedded player functionality that lets you configure the player to load search results. This announcement affects the player's list and listType parameters.

This change will become effective on or after 15 November 2020. After that time, setting the listType parameter value to search will generate a 4xx response code, such as 404 (Not Found) or 410 (Gone).

As an alternative, you can use the YouTube Data API's search.list method to retrieve search results and then load selected videos in the player.

In addition to the change described above, the showinfo parameter, which was deprecated in 2018, has been removed from this document.

August 23, 2018

Note: This is a deprecation announcement for the showinfo parameter. In addition, the behavior for the rel parameter is changing. Titles, channel information, and related videos are an important part of YouTube’s core user experience, and these changes help to make the YouTube viewing experience consistent across different platforms.

  • The behavior for the rel parameter is changing on or after September 25, 2018. The effect of the change is that you will not be able to disable related videos. However, you will have the option of specifying that the related videos shown in the player should be from the same channel as the video that was just played.

    To be more specific:
    • Prior to the change, if the parameter's value is set to 0, then the player does not show related videos.
    • After the change, if the rel parameter is set to 0, the player will show related videos that are from the same channel as the video that was just played.
  • The showinfo parameter, which indicates whether the player should display information like the video title and uploader before the video starts playing, is also being deprecated. Following the change, the channel avatar and video title will always display before playback begins, when playback is paused, and when playback ends. The avatar being displayed is new behavior that will be consistent across all embedded players.

These changes will become effective on or after September 25, 2018. After that time, the showinfo parameter will be ignored. The behavior following the changes is consistent with the current default behavior for embedded players with the exception of the channel avatar changes mentioned above.

August 16, 2018

The cc_lang_pref parameter can be used to specify the default language that the player will use to display captions. This parameter can be used in conjunction with the cc_load_policy parameter to automatically show captions in the specified language during playback.

September 15, 2017

The controls parameter's definition has been updated to remove references to the deprecated Flash (AS3) player. The value 2 has been deprecated as it was originally designed to provide a performance improvement for embeds that loaded a Flash player.

June 12, 2017

The new widget_referrer parameter helps to enable more accurate YouTube Analytics reporting when the YouTube player is embedded in a widget, and that widget is then embedded in a web page or application.

November 1, 2016

This document has been updated to remove references to the deprecated Flash (AS3) player as well as to parameters only supported by that player. The YouTube Flash player was deprecated in January 2015.

October 20, 2016

This update contains the following changes:

  • The disablekb parameter definition has been corrected to note that the default value is 0, which means that keyboard controls are enabled. A value of 1 indicates that keyboard controls should be disabled.

    The list of keyboard controls that the player supports has also been updated to include the following:

    • [f]: Toggle full-screen display
    • [j]: Jump back 10 seconds in the current video
    • [k]: Play / Pause
    • [l]: Jump ahead 10 seconds in the current video
    • [m]: Mute or unmute the video
    • [0-9]: Jump to a point in the video. 0 jumps to the beginning of the video, 1 jumps to the time 10% into the video, 2 jumps to the point 20% into the video, and so forth.

    In addition, the effect of pressing the [arrow left] or [arrow right] keys has changed. These keys now jump 5 seconds back (arrow left) or ahead (arrow right) in the current video.

August 11, 2016

This update contains the following changes:

  • The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog, provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms, which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.

    The full set of new documents is described in the revision history for the Updated Terms. In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.

December 18, 2015

European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy. We have added a notice of this requirement in our YouTube API Terms of Service.

August 19, 2015

  • The autohide parameter has been deprecated for the HTML5 player. In HTML5 players, the video progress bar and player controls display or hide automatically. That behavior corresponds to an autohide setting of 1.

  • The theme parameter has been deprecated for the HTML5 player. HTML5 players now always use the dark theme.

March 9, 2015

  • The document has been updated to reflect the fact that YouTube <object> embeds, the YouTube Flash Player API and the YouTube JavaScript Player API have all been deprecated as of January 27, 2015. A deprecation warning appears in several sections of this document to help point readers to the IFrame Player API as an alternative.

  • The definition of the autohide parameter has been updated to clarify the meaning of the parameter's values. The default behavior (autohide=2) is that if the player has a 16:9 or 4:3 aspect ratio, the player's video progress bar and player controls display or hide automatically. Otherwise, those controls are visible throughout the video.

  • The definition of the hl parameter has been updated to note that the parameter value could be an ISO 639-1 two-letter language code or a fully specified locale. For example, fr and fr-ca are both valid parameter values.

  • The definition of the enablejsapi parameter has been reworded to clarify that the parameter enables a player to be controlled via API calls. The API could be either the IFrame Player API or the JavaScript Player API.

October 14, 2014

July 18, 2014

  • The new hl parameter can be used to set the player's interface language. The interface language is used for tooltips in the player and also affects the default caption track. The selected caption track may also depend on the availability of caption tracks and user's individual language preferences.

    The parameter's value is an ISO 639-1 two-letter language code, though other language input codes, such as IETF language tags (BCP 47) may also be handled properly.

  • The definition of the playsinline parameter, which only affects HTML5 players on iOS, has been modified slightly. The definition now notes that setting the parameter value to 1 causes inline playback only for UIWebViews created with the allowsInlineMediaPlayback property set to TRUE.

January 28, 2014

  • The playsinline parameter controls whether videos play inline or fullscreen in an HTML5 player on iOS. Setting the value to 1 causes inline playback.

  • The Selecting content to play section has been updated to explain how to find YouTube video IDs and playlist IDs using the YouTube Data API (v3) rather than the older API version.

  • The controls parameter's definition has been updated to reflect the fact that the parameter value only affects the time that the Flash player actually loads in IFrame embeds. In addition, for IFrame embeds, the parameter value also determines when the controls display in the player. If you set the parameter's value to 2, then the controls display and the Flash player loads after the user initiates the video playback.

May 10, 2013

This update contains the following changes:

July 20, 2012

This update contains the following changes:

  • The definition of the controls parameter has been updated to reflect support for a parameter value of 2 and to explain that, for AS3 players, the parameter value determines the time when the Flash player actually loads. If the controls parameter is set to 0 or 1, the Flash player loads immediately. If the parameter value is 2, the Flash player does not load until the video playback is initiated.

June 5, 2012

This update contains the following changes:

  • The HTML5 player now supports the color, modestbranding, and rel parameters, and the definitions for these parameters have been updated accordingly.

  • The definition of the showinfo parameter has been updated to explain how that if the player is loading a playlist, and you explicitly set the parameter value to 1, then, upon loading, the player will also display thumbnail images for the videos in the playlist. Note that this functionality is only supported for the AS3 player since that is the only player that can load a playlist.

May 4, 2012

This update contains the following changes:

  • The showinfo parameter's definition has been updated to reflect the fact that the HTML5 player supports this parameter.

May 3, 2012

This update contains the following changes:

  • The new end parameter specifies the time, measured in seconds from the start of the video, when the player should stop playing a video. Note that the time when playback is stopped is measured from the beginning of the video and not from the value of either the start player parameter or the startSeconds parameter, which is used in YouTube Player API functions for loading or queueing a video.

March 29, 2012

This update contains the following changes:

  • The new Embedding a YouTube player section explains different ways to embed a YouTube player in your application. This section covers manual IFrame embeds, IFrame embeds that use the IFrame Player API, and AS3 and AS2 object embeds. This section incorporates information from the old Example usage section, which has been removed.

  • The new Selecting content to play section explains how to configure the player to load a video, a playlist, search results for a specified query, or uploaded videos for a specified user.

  • The new list and listType parameters let you specify the content that the player should load. You can specify a playlist, a search query, or a particular user's uploaded videos.

  • The definitions of the fs and rel parameters have been updated to more clearly explain the default parameter values for the AS3 player.

  • The border, color1, egm, hd, and showsearch parameters, which are all only supported for the deprecated AS2 Player API, have been moved to a new section named deprecated parameters only used in the AS2 Player API.

  • The document no longer provides a way to filter the parameter list to only display parameters supported in either the AS3, AS2, or HTML5 player. Instead, each parameter definition has been updated to identify the players that support that parameter.

August 11, 2011

This update contains the following changes:

  • The new theme and color parameters let you customize the appearance of the embedded player's player controls. See the YouTube API blog for more information.

June 8, 2011

This update contains the following changes:

  • The new modestbranding parameter lets you use a YouTube player that does not show a YouTube logo. As of this release, the parameter was only supported for the AS3 embedded player and for IFrame embeds that loaded the AS3 player. As of June 5, 2012, the HTML5 player also supported this parameter.

February 14, 2011

This update contains the following changes:

  • The documentation has been updated to note that the AS2 Player API has been deprecated. The deprecation of the AS2 Player API was actually announced on October 14, 2009.

February 3, 2011

This update contains the following changes:

  • The documentation has been updated to identify parameters supported in the HTML5 (IFrame) embedded player.

  • The document now displays all of the parameters supported in any of YouTube's embedded players (HTML5, AS3, AS2).

  • The following parameters are supported in the AS2 player but have been deprecated for the newer AS3 and HTML5 players: border, color1, color2, egm, hd, and showsearch.

    In addition, the loop parameter has limited support in the AS3 player and in IFrame embeds, which could load either an AS3 or HTML player. Currently, the loop parameter only works in the AS3 player when used in conjunction with the playlist parameter. To loop a single video, set the loop parameter to 1 and set the playlist parameter value to the same video ID already specified in the Player API URL:

    https://www.youtube.com/v/VIDEO_ID?version=3&loop=1&playlist=VIDEO_ID

    Similarly, the controls and playlist parameters are supported in the AS3 and HTML5 players but are not and will not be supported in the AS2 player.

    As noted above, IFrame embeds can load either an AS3 or HTML5 player. Though some parameters are not supported in both players, an IFrame embed that loads the AS3 player will support all parameters that work with that player and ignore all other parameters. Similarly, an IFrame embed that loads the HTML5 player will support all parameters that work with that player while ignoring all other parameters.

  • The parameter list has been updated to include the autohide parameter, which indicates whether the player's video controls will automatically hide after a video begins playing.

  • The parameter list has been updated to include the controls parameter, which indicates whether the player's video controls will display at all. (Player controls do display by default.)

  • The parameter list has been updated to include the playlist parameter, which specifies a comma-separated list of video IDs to play.

  • The definition of the fs has been updated to note that the fullscreen option will not work if you load the YouTube player into another SWF.

  • The example at the end of the document has been updated to use the embedded AS3 player instead of the embedded AS2 player. The parameters used in the example have also been updated to only include parameters that the AS3 player supports.

    In addition, the instructions for constructing the URLs that contain player parameters have been updated to reflect the URL formats used by the AS3 and AS2 embedded and chromeless players as well as by the HTML5 player.