Không gian tên: truyền

chrome.truyền

không gian tên   tĩnh

Đây là vùng chứa tên chrome.cast.

Lớp

ApiConfig

Lưu giữ cấu hình cho API khi được khởi tạo.

CredentialsData

Dữ liệu thông tin xác thực dùng để xác định thông tin xác thực của người gửi.

DialRequest

Yêu cầu khởi động ứng dụng DIAL.

Lỗi

Mô tả lỗi mà API trả về. Thông thường, ứng dụng không được tạo các đối tượng này.

Image

Hình ảnh mô tả ứng dụng của trình nhận hoặc mục nội dung đa phương tiện. Đó có thể là biểu tượng ứng dụng, ảnh bìa hoặc hình thu nhỏ.

Người nhận

Mô tả trình thu nhận đang chạy ứng dụng. Thông thường, ứng dụng không được tạo các đối tượng này.

ReceiverDisplayStatus

Trạng thái của thiết bị nhận sẽ hiển thị với người dùng trong giao diện người dùng tiện ích. Chỉ hợp lệ cho người nhận CUSTOM.

SenderApplication

Mô tả ứng dụng của người gửi. Thông thường, ứng dụng không được tạo các đối tượng này.

Phiên

Mô tả trạng thái của ứng dụng Truyền hiện đang chạy. Thông thường, ứng dụng không được tạo các đối tượng này.

SessionRequest

Yêu cầu bắt đầu hoặc kết nối với một phiên.

Thời gian chờ

Xác định giá trị thời gian chờ mặc định tính bằng mili giây cho các phương thức API.

Âm lượng

Âm lượng của một thiết bị hoặc luồng nội dung nghe nhìn.

Không gian tên

media

Bảng liệt kê

AutoJoinPolicy

tĩnh

string

Chính sách tự động tham gia xác định thời điểm SDK sẽ tự động kết nối một ứng dụng của người gửi với một phiên hiện có sau khi khởi chạy API.

Giá trị
TAB_AND_ORIGIN_SCOPED	string Tự động kết nối khi phiên được bắt đầu bằng cùng một appId, trong cùng một thẻ và nguồn gốc trang.
ORIGIN_SCOPED	string Tự động kết nối khi phiên được bắt đầu bằng cùng một appId và cùng một nguồn gốc trang (bất kể thẻ nào).
PAGE_SCOPED	string Không có kết nối tự động.

Chức năng

tĩnh

string

Các chức năng mà thiết bị nhận hỗ trợ.

Giá trị
VIDEO_OUT	string Bộ thu hỗ trợ đầu ra video.
AUDIO_OUT	string Bộ thu hỗ trợ đầu ra âm thanh.
VIDEO_IN	string Bộ thu hỗ trợ đầu vào video (máy ảnh).
AUDIO_IN	string Bộ thu hỗ trợ đầu vào âm thanh (micrô).
MULTIZONE_GROUP	string Trình nhận đại diện cho một nhóm nhiều vùng.

DefaultActionPolicy

tĩnh

string

Chính sách hành động mặc định xác định thời điểm SDK sẽ tự động tạo một phiên sau khi khởi chạy API. Thao tác này cũng kiểm soát thao tác mặc định cho thẻ trong cửa sổ bật lên của tiện ích.

Giá trị
CREATE_SESSION	string Nếu thẻ chứa ứng dụng đang được truyền khi API khởi chạy, SDK sẽ ngừng truyền thẻ và tự động chạy ứng dụng. Cửa sổ bật lên của tiện ích nhắc người dùng truyền ứng dụng.
CAST_THIS_TAB	string Khởi chạy tự động không được thực hiện sau khi khởi chạy API, ngay cả khi thẻ đang được truyền. Cửa sổ bật lên của tiện ích nhắc người dùng truyền thẻ đó.

DialAppState

tĩnh

string

Các trạng thái có thể có của ứng dụng DIAL.

Giá trị
ĐI VÀO HOẠT ĐỘNG	string
ĐÃ DỪNG	string
ERROR (LỖI)	string Không thuộc thông số kỹ thuật, dùng để báo hiệu lỗi.

ErrorCode

tĩnh

string

Các lỗi có thể do SDK trả về.

Giá trị
HUỶ	string Người dùng đã huỷ thao tác này.
TIMEOUT	string Đã hết giờ cho thao tác.
API_NOT_INITIALIZED	string API này chưa được khởi tạo.
INVALID_PARAMETER	string Các tham số cho toán tử không hợp lệ.
EXTENSION_NOT_COMPATIBLE	string Tập lệnh API không tương thích với tiện ích Truyền đã cài đặt.
EXTENSION_MISSING	string Tiện ích Truyền không khả dụng.
RECEIVER_UNAVAILABLE	string Không có bộ thu nào tương thích với yêu cầu phiên.
SESSION_ERROR	string Không thể tạo phiên hoặc phiên không hợp lệ.
CHANNEL_ERROR	string Không có kênh đến người nhận.
LOAD_MEDIA_FAILED	string Không tải được nội dung nghe nhìn.

ReceiverAction

tĩnh

string

Những thao tác mà người dùng có thể thực hiện đối với một bộ nhận trong tiện ích. Bạn có thể dùng chúng để hiển thị quá trình chuyển đổi trong giao diện người dùng của ứng dụng gửi trước khi hành động truyền hoàn tất (hoặc không thành công).

Giá trị
CAST	string Người dùng đã chọn một trình nhận với ý định truyền tới trình nhận đó bằng ứng dụng của người gửi. Danh tính chính xác của người nhận có thể không được xác định.
DỪNG	string Người dùng đã yêu cầu dừng phiên đang chạy trên bộ thu.

ReceiverAvailability

tĩnh

string

Mô tả khả năng sử dụng của thiết bị nhận nội dung Truyền.

Giá trị
HIỆN CÓ	string Có ít nhất một bộ thu tương thích với yêu cầu phiên.
KHÔNG DÙNG ĐƯỢC	string Không có đầu thu nào.

ReceiverType

tĩnh

string

Giá trị
CAST	string Thiết bị nhận nội dung truyền, ví dụ: Chromecast
XOÁ	string Thiết bị DIAL, ví dụ: TV thông minh
CPV	string Đi chơi
TÙY CHỈNH	string Bộ nhận tuỳ chỉnh do khách hàng cung cấp

SenderPlatform

tĩnh

string

Mô tả nền tảng ứng dụng của người gửi.

Giá trị
CHROME	string
IOS	string
ANDROID	string

SessionStatus

tĩnh

string

Mô tả trạng thái của phiên Truyền cho ứng dụng nhận.

Giá trị
ĐÃ KẾT NỐI	string Phiên được kết nối với ứng dụng của người nhận.
ĐÃ NGẮT KẾT NỐI	string Phiên bị ngắt kết nối khỏi ứng dụng của người nhận. Ứng dụng nhận có thể vẫn đang chạy hoặc không.
ĐÃ DỪNG	string Ứng dụng nhận đã bị dừng.

VolumeControlType

tĩnh

string

Mô tả các loại điều chỉnh âm lượng.

Giá trị
THU HÚT	string Bạn có thể thay đổi âm lượng của thiết bị truyền.
cố định	string Âm lượng của thiết bị truyền là cố định và không thể thay đổi.
CHỦ SỞ HỮU	string Điều khiển âm lượng chính của hệ thống, tức là âm lượng của TV hoặc Thiết bị âm thanh được thay đổi.

Thuộc tính

AutoJoinPolicy

tĩnh

string

Chính sách tự động tham gia xác định thời điểm SDK sẽ tự động kết nối một ứng dụng của người gửi với một phiên hiện có sau khi khởi chạy API.

Giá trị
TAB_AND_ORIGIN_SCOPED	string Tự động kết nối khi phiên được bắt đầu bằng cùng một appId, trong cùng một thẻ và nguồn gốc trang.
ORIGIN_SCOPED	string Tự động kết nối khi phiên được bắt đầu bằng cùng một appId và cùng một nguồn gốc trang (bất kể thẻ nào).
PAGE_SCOPED	string Không có kết nối tự động.

Chức năng

tĩnh

string

Các chức năng mà thiết bị nhận hỗ trợ.

Giá trị
VIDEO_OUT	string Bộ thu hỗ trợ đầu ra video.
AUDIO_OUT	string Bộ thu hỗ trợ đầu ra âm thanh.
VIDEO_IN	string Bộ thu hỗ trợ đầu vào video (máy ảnh).
AUDIO_IN	string Bộ thu hỗ trợ đầu vào âm thanh (micrô).
MULTIZONE_GROUP	string Trình nhận đại diện cho một nhóm nhiều vùng.

DefaultActionPolicy

tĩnh

string

Chính sách hành động mặc định xác định thời điểm SDK sẽ tự động tạo một phiên sau khi khởi chạy API. Thao tác này cũng kiểm soát thao tác mặc định cho thẻ trong cửa sổ bật lên của tiện ích.

Giá trị
CREATE_SESSION	string Nếu thẻ chứa ứng dụng đang được truyền khi API khởi chạy, SDK sẽ ngừng truyền thẻ và tự động chạy ứng dụng. Cửa sổ bật lên của tiện ích nhắc người dùng truyền ứng dụng.
CAST_THIS_TAB	string Khởi chạy tự động không được thực hiện sau khi khởi chạy API, ngay cả khi thẻ đang được truyền. Cửa sổ bật lên của tiện ích nhắc người dùng truyền thẻ đó.

DialAppState

tĩnh

string

Các trạng thái có thể có của ứng dụng DIAL.

Giá trị
ĐI VÀO HOẠT ĐỘNG	string
ĐÃ DỪNG	string
ERROR (LỖI)	string Không thuộc thông số kỹ thuật, dùng để báo hiệu lỗi.

ErrorCode

tĩnh

string

Các lỗi có thể do SDK trả về.

Giá trị
HUỶ	string Người dùng đã huỷ thao tác này.
TIMEOUT	string Đã hết giờ cho thao tác.
API_NOT_INITIALIZED	string API này chưa được khởi tạo.
INVALID_PARAMETER	string Các tham số cho toán tử không hợp lệ.
EXTENSION_NOT_COMPATIBLE	string Tập lệnh API không tương thích với tiện ích Truyền đã cài đặt.
EXTENSION_MISSING	string Tiện ích Truyền không khả dụng.
RECEIVER_UNAVAILABLE	string Không có bộ thu nào tương thích với yêu cầu phiên.
SESSION_ERROR	string Không thể tạo phiên hoặc phiên không hợp lệ.
CHANNEL_ERROR	string Không có kênh đến người nhận.
LOAD_MEDIA_FAILED	string Không tải được nội dung nghe nhìn.

isAvailable

tĩnh

boolean

Gắn cờ để ứng dụng kiểm tra xem API đã được tải hay chưa.

ReceiverAction

tĩnh

string

Những thao tác mà người dùng có thể thực hiện đối với một bộ nhận trong tiện ích. Bạn có thể dùng chúng để hiển thị quá trình chuyển đổi trong giao diện người dùng của ứng dụng gửi trước khi hành động truyền hoàn tất (hoặc không thành công).

Giá trị
CAST	string Người dùng đã chọn một trình nhận với ý định truyền tới trình nhận đó bằng ứng dụng của người gửi. Danh tính chính xác của người nhận có thể không được xác định.
DỪNG	string Người dùng đã yêu cầu dừng phiên đang chạy trên bộ thu.

ReceiverAvailability

tĩnh

string

Mô tả khả năng sử dụng của thiết bị nhận nội dung Truyền.

Giá trị
HIỆN CÓ	string Có ít nhất một bộ thu tương thích với yêu cầu phiên.
KHÔNG DÙNG ĐƯỢC	string Không có đầu thu nào.

ReceiverType

tĩnh

string

Giá trị
CAST	string Thiết bị nhận nội dung truyền, ví dụ: Chromecast
XOÁ	string Thiết bị DIAL, ví dụ: TV thông minh
CPV	string Đi chơi
TÙY CHỈNH	string Bộ nhận tuỳ chỉnh do khách hàng cung cấp

SenderPlatform

tĩnh

string

Mô tả nền tảng ứng dụng của người gửi.

Giá trị
CHROME	string
IOS	string
ANDROID	string

SessionStatus

tĩnh

string

Mô tả trạng thái của phiên Truyền cho ứng dụng nhận.

Giá trị
ĐÃ KẾT NỐI	string Phiên được kết nối với ứng dụng của người nhận.
ĐÃ NGẮT KẾT NỐI	string Phiên bị ngắt kết nối khỏi ứng dụng của người nhận. Ứng dụng nhận có thể vẫn đang chạy hoặc không.
ĐÃ DỪNG	string Ứng dụng nhận đã bị dừng.

tạm ngừng

tĩnh

chrome.cast.Timeout không có giá trị null

Giá trị thời gian chờ mặc định tính bằng mili giây cho các phương thức API.

PHIÊN BẢN

hằng số   tĩnh

mảng số không rỗng

Phiên bản API. Số đầu tiên là phiên bản lớn và số thứ hai là phiên bản phụ.

VolumeControlType

tĩnh

string

Mô tả các loại điều chỉnh âm lượng.

Giá trị
THU HÚT	string Bạn có thể thay đổi âm lượng của thiết bị truyền.
cố định	string Âm lượng của thiết bị truyền là cố định và không thể thay đổi.
CHỦ SỞ HỮU	string Điều khiển âm lượng chính của hệ thống, tức là âm lượng của TV hoặc Thiết bị âm thanh được thay đổi.

Phương thức

addReceiverActionListener

tĩnh

addReceiverActionListener(listener)

Thêm hàm trình nghe sẽ được gọi khi người dùng thực hiện thao tác thông qua giao diện người dùng để bắt đầu hoặc dừng truyền. Ứng dụng gửi có thể sử dụng tính năng này để hiển thị quá trình chuyển đổi trong giao diện người dùng (tức là tạm dừng phát nội dung nghe nhìn trên máy) trước khi hành động truyền hoàn tất hoặc không thành công.

• Trình nghe này không đảm bảo sẽ được gọi và các ứng dụng không nên dựa vào trình nghe này để hoạt động chính xác.
• Trình nghe này sẽ được truyền đến trình nhận đang được thực thi, nếu có. Tuy nhiên, trình thu nhận có thể không xác định và giá trị rỗng sẽ được truyền.
• Trình nghe này sẽ được gọi sớm nhất có thể sau khi người dùng thực hiện hành động. API này phải được gọi trước khi ứng dụng nhận được thông báo về sự thay đổi trạng thái thông qua API.

Nếu bạn sử dụng API Khung, hãy sử dụng cast.framework.CastContext#addEventListener và nghe các sự kiện Cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Thông số
trình nghe	chrome.cast.ReceiverActionListener Hàm trình nghe cần thêm. Đối số đầu tiên cho trình nghe là trình thu nhận được thực thi. Đối số thứ hai cho trình nghe là hành động đã được yêu cầu (xem chrome.cast.ReceiverAction). Giá trị không được rỗng.

initialize

tĩnh

khởi tạo(apiConfig, SuccessCallback, errorCallback)

Khởi chạy API. Xin lưu ý rằng SuccessCallback và errorCallback sẽ được gọi sau khi API hoàn tất quá trình khởi chạy. sessionListener và receiverListener có thể được gọi bất cứ lúc nào sau đó và có thể nhiều hơn một lần.

Nếu bạn sử dụng API Khung, hãy dùng cast.framework.CastContext#setOptions thay vì hàm này.

Thông số
apiConfig	chrome.cast.ApiConfig Đối tượng có các tham số để khởi chạy API. Giá trị không được rỗng.
successCallback	hàm()
errorCallback	function(non-null chrome.cast.Error) Các lỗi có thể xảy ra là TIMEOUT, INVALID_Parameters, EXTENSION_DEFAULT.

logMessage

tĩnh

logMessage(message)

Ghi nhật ký một thông báo gỡ lỗi từ ứng dụng. Thông báo này có thể được gửi qua báo cáo phản hồi cho Google nếu người dùng chọn đưa vào nhật ký chi tiết một cách rõ ràng.

Thông số
tin nhắn	string Tin nhắn cần ghi nhật ký.

Không được dùng nữa

Không được hỗ trợ với SDK truyền dựa trên API Bản trình bày.

lưu trước vào bộ nhớ đệm

tĩnh

precache(dữ liệu)

Gửi yêu cầu lưu trước dữ liệu vào bộ nhớ đệm. Nếu một phiên được kết nối, thì phiên đó sẽ gửi một yêu cầu trực tiếp, nếu không, phiên sẽ gửi đến tất cả các thiết bị trong mạng.

Thông số
data	string Dữ liệu cần lưu vào bộ nhớ đệm.

Không được dùng nữa

Không được hỗ trợ.

removeReceiverActionListener

tĩnh

removeReceiverActionListener(listener)

Xoá một hàm trình nghe trước đó đã được thêm bằng addReceiverActionListener.

Thông số
trình nghe	chrome.cast.ReceiverActionListener Hàm trình nghe để xoá. Giá trị không được rỗng.

requestSession

tĩnh

requestSession(successCallback, errorCallback, sessionRequest)

Yêu cầu tạo hoặc tham gia một phiên ứng dụng của trình nhận. Theo mặc định, SessionRequest được chuyển đến API tại thời điểm khởi chạy sẽ được sử dụng; bạn có thể ghi đè yêu cầu này bằng cách chuyển một yêu cầu phiên khác trong sessionRequest.

Nếu bạn sử dụng API Khung, hãy sử dụng cast.framework.CastContext#requestSession thay vì hàm này.

Thông số
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) Các lỗi có thể xảy ra là TIMEOUT, INVALID_METRIC, API_NOT_Liên tiếp Xin lưu ý rằng bộ tính giờ hết thời gian chờ bắt đầu sau khi người dùng chọn thiết bị nhận. Việc chọn bộ nhận yêu cầu người dùng phải thực hiện thao tác và thao tác này không có thời gian chờ. Nếu đang xử lý một yêu cầu phiên, thì errorCallback sẽ được gọi bằng mã lỗi INVALID_parameter và nội dung mô tả giải thích lỗi đó.
sessionRequest	Không bắt buộc chrome.cast.SessionRequest Giá trị không được rỗng.

requestSessionById

tĩnh

requestSessionById(sessionId)

Yêu cầu tham gia một phiên hiện có bằng mã đã cho. Sau khi tham gia, phiên sẽ được chuyển đến sessionListener do chrome.cast.initialize đặt.

Nếu phiên có mã sessionId đã cho đã được xác định khi hàm này được gọi, thì sessionListener sẽ được gọi ngay lập tức. Nếu không, sau khi phát hiện một phiên có mã phiên nhất định, sessionListener sẽ được gọi.

Thông số
sessionId	string Mã của phiên cần tham gia.

setCustomReceivers

tĩnh

setCustomReceivers(receivers, successCallback, errorCallback)

Đặt danh sách người nhận tuỳ chỉnh

Thông số
máy thu	Mảng chrome.cast.Receiver khác rỗng Danh sách mới. Giá trị không được rỗng.
successCallback	hàm()
errorCallback	function(non-null chrome.cast.Error) Các lỗi có thể xảy ra là TIMEOUT, API_NOT_italicIZED, INVALID_METRIC, CHANNEL_ERROR và EXTENSION_MISS sánh.

Không được dùng nữa

Không được hỗ trợ với SDK truyền dựa trên API Bản trình bày.

setPageContext

tĩnh

setPageContext(win)

Khởi chạy chức năng Truyền cho một trang tải SDK Truyền trong iframe. Phải được gọi sau khi SDK được khởi chạy.

Thông số
thắng	Cửa sổ Đối tượng cửa sổ trang. Giá trị không được rỗng.

setReceiverDisplayStatus

tĩnh

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Đặt tên người nhận và trạng thái hiển thị. Để cho thấy trình thu nhận là đang rảnh, hãy đặt displayStatus thành rỗng.

Chỉ hợp lệ cho người nhận CUSTOM. displayStatus của trình thu nhận sẽ bị bỏ qua nếu trình thu này là CAST; ứng dụng của trình thu nhận cập nhật trạng thái của trình thu truyền này.

Thông số
người nhận	chrome.cast.Receiver Người nhận. Giá trị không được rỗng.
successCallback	hàm() Lệnh gọi lại khi đặt trạng thái thành công.
errorCallback	function(non-null chrome.cast.Error) Các lỗi có thể xảy ra là TIMEOUT, INVALID_ CNTT, API_NOT_InitialIZED và EXTENSION_DEFAULT.

Không được dùng nữa

Không được hỗ trợ với SDK truyền dựa trên API Bản trình bày.

unescape

tĩnh

không thoát(thoát) trả về chuỗi

Phương thức tiện ích để không thoát khỏi các chuỗi thoát URI. Ví dụ: tên thân thiện với trình thu nhận được trả về dưới dạng chuỗi thoát URI. Hãy sử dụng phương thức này để huỷ thoát chuỗi đó nếu cần.

Thông số
đã thoát	string Một chuỗi để huỷ thoát

Trả bóng

string Chuỗi không thoát

Loại trừu tượng

ReceiverActionListener

tĩnh

ReceiverActionListener()