# การปรับตั้งค่า Options
# การปรับตั้งค่าผ่าน options
ในการปรับตั้งค่าของ ByteArk Player นั้นสามารถทำได้โดย options ขณะเรียกเมธอด byteark เพื่อสร้างตัวเล่นวิดีโอ โดยมี options หลักๆ ดังนี้
| Name | Type | Default | Description |
|---|---|---|---|
| autoplay | Boolean/String | - | เริ่มเล่นวิดีโออัตโนมัติ สามารถดูข้อมูลเพิ่มเติมได้จากหัวข้อ การเล่นวิดีโออัตโนมัติ |
| autoplayadsmuted | Boolean | false | ยอมให้เริ่มเล่นวิดีโออัตโนมัติและปิดเสียง เมื่อมีโฆษณา preroll สามารถดูข้อมูลเพิ่มเติมได้จากหัวข้อ การเล่นวิดีโออัตโนมัติ |
| audioOnlyMode | Boolean | false | ถ้าตั้งค่าเป็น true จะทำการซ่อน UI ต่างๆยกเว้น Control Bar ใช้สำหรับการเล่นไฟล์เสียงอย่างเดียว |
| audioPosterMode | Boolean | false | ถ้าตั้งค่าเป็น true จะทำการแสดงภาพปก (poster image) แทนการเล่นวิดีโอ ใช้สำหรับการเล่นไฟล์เสียงอย่างเดียว |
| muted | Boolean | - | เล่นวิดีโอแบบปิดเสียง |
| volume | Number | - | ระดับเสียงของวิดีโอมีค่าระหว่าง 0 ถึง 1 |
| aspectRatio | String | - | กำหนดอัตราส่วนภาพของวิดีโอ (16: 9) ใช้เมื่อมีการตั้งค่า fluid: true |
| controls | Boolean | true | แสดงหรือซ่อน แถบควบคุม |
| fluid | Boolean | - | ใช้การแสดงผล layout แบบ fluid (video player จะขยายขนาดจนเต็ม container) |
| loop | Boolean | - | เริ่มเล่นวิดีโอใหม่เมื่อเล่นจบ |
| playsinline | Boolean | true | แสดงผลวิดีโอแบบ inline |
| preload | String | - | ตั้งค่าให้ web browser preload วิดีโอหรือไม่ สามารถมีค่าเป็น auto : preload วิดีโอทันทีถ้าหาก web browser รองรับ none : ไม่ทำการ preload วิดีโอจนกว่าจะเริ่มเล่น |
| liveui | Boolean | - | เปิด/ปิด seekbar เมื่อเล่นวิดีโอ Live Stream แบบ DVR |
| autoSeekToLiveEdge | Boolean | - | seek ไปที่เวลาล่าสุดของ live stream หลังจากมีการ pause และ play live stream |
| closedCaptionButton | Boolean | false | แสดงปุ่ม Close Caption/Subtitle ที่ control bar ถ้าหากวิดีโอมีซับไตเติ้ล |
| downloadUrl | String | - | แสดงปุ่ม Download ที่ control bar เมื่อมีการใส่ url สำหรับดาวน์โหลดไฟล์ |
| poster | String | - | URL ของรูปภาพสำหรับแสดงผลก่อนเริ่มเล่นวิดีโอ |
| sources | Object/Array | - | Source ของวิดีโอที่ใช้เล่น (ดูตัวอย่าง source object) |
| plugins | Object | - | ปลั๊กอินเพิ่มความสามารถในการใช้งานของ ByteArk Player |
| errors | Object | - | แสดงรูปภาพเมื่อมี error เกิดขึ้นตาม http status code (ตูตัวอย่าง error object) |
| xhrSetup | Function | - | xhr setup function (xhr: XMLHttpRequest, url: string) => void |
Note
เนืองจาก ByteArk Player พัฒนาโดยมีพื้นฐานมาจาก Video.js ทำให้สามารถใช้งาน options ต่างๆ ของ Video.js ได้ ซึ่งสามารถดู options ทั้งหมดได้จากเอกสารของ Video.js (opens new window)
# Source object
| Name | Type | Required | Description |
|---|---|---|---|
| src | String | Yes | URL ของวิดีโอ |
| type | String | Yes | ประเภทของวิดีโอ |
| title | String | No | ชื่อของวิดีโอที่จะนำมาแสดงบน video player * Required เมื่อเปิดใช้งาน ByteArk Lighthouse |
| subtitle | String | No | ชื่อตอน หรือรายละเอียดสั้นๆของวิดีโอ |
| videoId | String | No | ไอดีของวิดีโอในระบบ ByteArk * Required เมื่อเปิดใช้งาน ByteArk Lighthouse |
| poster | String | No | URL ของรูปภาพวิดีโอ |