TextTrack
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
* Some parts of this feature may have varying levels of support.
Giao diện TextTrack của WebVTT API đại diện cho một text track liên kết với một phần tử media.
Một đối tượng kiểu này sở hữu danh sách các đối tượng VTTCue sẽ được hiển thị phía trên video tại các thời điểm khác nhau.
Các đối tượng TextTrack có thể được thêm vào phần tử HTMLVideoElement hoặc HTMLAudioElement bằng phương thức HTMLMediaElement.addTextTrack(), tương tự như thêm text track theo cách khai báo bằng các phần tử <track> bên trong phần tử <video> hoặc <audio>.
Các đối tượng TextTrack được lưu trữ trong TextTrackList, có thể truy cập bằng thuộc tính HTMLMediaElement.textTracks.
Thuộc tính phiên bản
Giao diện này cũng kế thừa các thuộc tính từ EventTarget.
TextTrack.activeCuesRead only-
Một đối tượng
TextTrackCueListliệt kê tập hợp các cue của text track hiện đang hoạt động. Các cue của track đang hoạt động nếu vị trí phát lại hiện tại của media nằm giữa thời gian bắt đầu và kết thúc của các cue. Do đó, đối với các cue được hiển thị như phụ đề, các cue đang hoạt động hiện đang được hiển thị. TextTrack.cuesRead only-
Một
TextTrackCueListchứa tất cả các cue của track. TextTrack.idRead only-
Một chuỗi xác định track, nếu có. Nếu không có ID, giá trị này là chuỗi rỗng (
""). NếuTextTrackđược liên kết với phần tử<track>, thì ID của track khớp với ID của phần tử. TextTrack.inBandMetadataTrackDispatchTypeRead only-
Trả về một chuỗi cho biết loại điều phối track metadata in-band của track.
TextTrack.kindRead only-
Trả về một chuỗi cho biết loại text track mà
TextTrackmô tả. Phải là một trong các giá trị được phép. TextTrack.labelRead only-
Một chuỗi có thể đọc được chứa nhãn của text track, nếu có; nếu không, đây là chuỗi rỗng (
""), trong trường hợp đó cần phải tạo nhãn tùy chỉnh bằng code của bạn sử dụng các thuộc tính khác của track, nếu nhãn của track cần được hiển thị cho người dùng. TextTrack.languageRead only-
Một chuỗi chỉ định ngôn ngữ mà nội dung của text track được viết. Giá trị phải là BCP 47 language tag hợp lệ, ví dụ
"en-US"cho tiếng Anh Mỹ hoặc"pt-BR"cho tiếng Bồ Đào Nha Brazil. TextTrack.mode-
Một chuỗi chỉ định chế độ hiện tại của track, phải là một trong các giá trị được phép. Việc thay đổi giá trị của thuộc tính này sẽ thay đổi chế độ hiện tại của track để khớp. Mặc định là
disabled, trừ khi thuộc tính booleandefaultcủa phần tử<track>được đặt thànhtrue, trong trường hợp đó chế độ mặc định làshowing. sourceBufferRead only-
SourceBufferđã tạo track. Trả về null nếu track không được tạo bởiSourceBufferhoặcSourceBufferđã bị xóa khỏi thuộc tínhMediaSource.sourceBufferscủa nguồn media cha.
Phương thức phiên bản
Giao diện này cũng kế thừa các phương thức từ EventTarget.
Note:
Giao diện TextTrackCue là một lớp trừu tượng được dùng làm lớp cha cho các giao diện cue khác như VTTCue. Do đó, khi thêm hoặc xóa một cue, bạn sẽ truyền vào một trong các kiểu cue kế thừa từ TextTrackCue.
TextTrack.addCue()-
Thêm một cue (được chỉ định là đối tượng
TextTrackCue) vào danh sách các cue của track. TextTrack.removeCue()-
Xóa một cue (được chỉ định là đối tượng
TextTrackCue) khỏi danh sách các cue của track.
Sự kiện
cuechange-
Kích hoạt khi các cue được vào và thoát. Một cue văn bản nhất định xuất hiện khi cue được vào và biến mất khi cue thoát. Cũng có thể truy cập qua thuộc tính
oncuechange.
Ví dụ
Ví dụ sau thêm một TextTrack mới vào video, sau đó đặt nó để hiển thị bằng TextTrack.mode.
let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";
Thông số kỹ thuật
| Specification |
|---|
| HTML # texttrack |