فضای نام: بازیگران

کروم قالب

فضای نام ایستا

این فضای نام chrome.cast است.

کلاس ها

ApiConfig

پیکربندی API را در زمان اولیه نگه می‌دارد.

اطلاعات اعتباری

داده های اعتبار مورد استفاده برای شناسایی اعتبار فرستنده.

DialRequest

درخواستی برای راه اندازی برنامه DIAL.

خطا

خطای بازگشتی توسط API را توصیف می کند. به طور معمول، این اشیاء نباید توسط مشتری ایجاد شوند.

تصویر

تصویری که یک برنامه گیرنده یا آیتم رسانه ای را توصیف می کند. این می تواند یک نماد برنامه، نقاشی روی جلد یا یک تصویر کوچک باشد.

گیرنده

گیرنده ای که یک برنامه را اجرا می کند را توصیف می کند. به طور معمول، این اشیاء نباید توسط مشتری ایجاد شوند.

ReceiverDisplay Status

وضعیت گیرنده در رابط کاربری برنامه افزودنی به کاربر نشان داده شده است. فقط برای گیرنده های سفارشی معتبر است.

SenderApplication

یک برنامه فرستنده را توصیف می کند. به طور معمول، این اشیاء نباید توسط مشتری ایجاد شوند.

جلسه

وضعیت برنامه Cast در حال اجرا را شرح می دهد. به طور معمول، این اشیاء نباید توسط مشتری ایجاد شوند.

SessionRequest

درخواستی برای شروع یا اتصال به یک جلسه.

تایم اوت

مقادیر مهلت زمانی پیش‌فرض را در میلی‌ثانیه برای روش‌های API تعریف می‌کند.

جلد

حجم یک دستگاه یا جریان رسانه.

فضای نام

رسانه ها

شمارش ها

AutoJoinPolicy

ایستا

رشته

خط مشی پیوستن خودکار تعیین می کند که SDK به طور خودکار یک برنامه فرستنده را پس از مقداردهی اولیه API به جلسه موجود متصل می کند.

ارزش
TAB_AND_ORIGIN_SCOPED	رشته هنگامی که جلسه با همان appId، در همان برگه و مبدا صفحه، به طور خودکار متصل می شود.
ORIGIN_SCOPED	رشته هنگامی که جلسه با همان appId و همان مبدا صفحه (صرف نظر از تب) شروع شد، به طور خودکار متصل می شود.
PAGE_SCOPED	رشته بدون اتصال خودکار

قابلیت

ایستا

رشته

قابلیت هایی که توسط دستگاه گیرنده پشتیبانی می شود.

ارزش
VIDEO_OUT	رشته گیرنده از خروجی ویدیو پشتیبانی می کند.
خروجی صدا	رشته گیرنده از خروجی صدا پشتیبانی می کند.
VIDEO_IN	رشته گیرنده از ورودی ویدئو (دوربین) پشتیبانی می کند.
ورودی صدا	رشته گیرنده از ورودی صدا (میکروفون) پشتیبانی می کند.
MULTIZONE_GROUP	رشته گیرنده یک گروه چند منطقه ای را نشان می دهد.

DefaultActionPolicy

ایستا

رشته

خط‌مشی اقدام پیش‌فرض تعیین می‌کند که کی SDK به‌طور خودکار جلسه‌ای را پس از مقداردهی اولیه API ایجاد می‌کند. این همچنین عملکرد پیش‌فرض برگه را در پنجره بازشو کنترل می‌کند.

ارزش
CREATE_SESSION	رشته اگر هنگام راه اندازی API، برگه حاوی برنامه ارسال شود، SDK ارسال برگه را متوقف می کند و به طور خودکار برنامه را راه اندازی می کند. پنجره بازشو از کاربر می خواهد که برنامه را ارسال کند.
CAST_THIS_TAB	رشته هیچ راه اندازی خودکار پس از مقداردهی اولیه API انجام نمی شود، حتی اگر برگه در حال ارسال باشد. پنجره بازشو از کاربر می خواهد که برگه را ارسال کند.

DialAppState

ایستا

رشته

حالت های احتمالی یک برنامه DIAL.

ارزش
در حال اجرا	رشته
متوقف شد	رشته
خطا	رشته بخشی از مشخصات نیست، برای سیگنال دادن به خطاها استفاده می شود.

کد خطا

ایستا

رشته

خطاهایی که ممکن است توسط SDK برگردانده شوند.

ارزش
لغو	رشته این عملیات توسط کاربر لغو شد.
تایم اوت	رشته زمان عملیات تمام شد.
API_NOT_INITIALIZED	رشته API راه اندازی نشده است.
INVALID_PARAMETER	رشته پارامترهای عملیات معتبر نبودند.
EXTENSION_NOT_COMPATIBLE	رشته اسکریپت API با برنامه افزودنی Cast نصب شده سازگار نیست.
EXTENSION_MISSING	رشته برنامه افزودنی Cast در دسترس نیست.
RECEIVER_UNAVAILABLE	رشته هیچ گیرنده ای با درخواست جلسه سازگار نبود.
SESSION_ERROR	رشته یک جلسه ایجاد نشد یا یک جلسه نامعتبر بود.
CHANNEL_ERROR	رشته کانالی به گیرنده در دسترس نیست.
LOAD_MEDIA_FAILED	رشته رسانه بارگیری نشد.

ReceiverAction

ایستا

رشته

اقداماتی که کاربر می تواند روی یک گیرنده در برنامه افزودنی انجام دهد. اینها را می توان برای نشان دادن یک انتقال در رابط کاربری برنامه فرستنده قبل از تکمیل کامل (یا ناموفق) عمل ارسال استفاده کرد.

ارزش
قالب	رشته کاربر یک گیرنده را با هدف ارسال به آن با برنامه فرستنده انتخاب کرد. ممکن است هویت دقیق گیرنده مشخص نباشد.
متوقف کردن	رشته کاربر درخواست توقف اجرای جلسه روی گیرنده را داد.

ReceiverAvailability

ایستا

رشته

در دسترس بودن گیرنده Cast را شرح می دهد.

ارزش
در دسترس	رشته حداقل یک گیرنده در دسترس است که با درخواست جلسه سازگار باشد.
غیر قابل دسترسی	رشته هیچ گیرنده ای در دسترس نیست.

نوع گیرنده

ایستا

رشته

ارزش
قالب	رشته گیرنده Cast، به عنوان مثال Chromecast
شماره گیری	رشته دستگاه DIAL، به عنوان مثال تلویزیون هوشمند
Hangout	رشته پاتوق
سفارشی	رشته گیرنده سفارشی ارائه شده توسط مشتری

پلتفرم فرستنده

ایستا

رشته

یک پلت فرم برنامه فرستنده را توصیف می کند.

ارزش
CHROME	رشته
IOS	رشته
اندروید	رشته

وضعیت جلسه

ایستا

رشته

وضعیت یک جلسه Cast را در برنامه گیرنده آن شرح می دهد.

ارزش
متصل	رشته جلسه به برنامه گیرنده متصل است.
قطع شده	رشته ارتباط جلسه با برنامه گیرنده قطع شده است. برنامه گیرنده ممکن است هنوز در حال اجرا باشد یا نباشد.
متوقف شد	رشته برنامه گیرنده متوقف شده است.

VolumeControlType

ایستا

رشته

انواع کنترل صدا را شرح می دهد.

ارزش
تضعیفی	رشته میزان صدای دستگاه Cast را می توان تغییر داد.
درست شد	رشته میزان صدای دستگاه Cast ثابت است و قابل تغییر نیست.
استاد	رشته کنترل صدا اصلی سیستم، یعنی صدای تلویزیون یا صدای دستگاه تغییر کرده است.

خواص

AutoJoinPolicy

ایستا

رشته

خط مشی پیوستن خودکار تعیین می کند که SDK به طور خودکار یک برنامه فرستنده را پس از مقداردهی اولیه API به جلسه موجود متصل می کند.

ارزش
TAB_AND_ORIGIN_SCOPED	رشته هنگامی که جلسه با همان appId، در همان برگه و مبدا صفحه، به طور خودکار متصل می شود.
ORIGIN_SCOPED	رشته هنگامی که جلسه با همان appId و همان مبدا صفحه (صرف نظر از تب) شروع شد، به طور خودکار متصل می شود.
PAGE_SCOPED	رشته بدون اتصال خودکار

قابلیت

ایستا

رشته

قابلیت هایی که توسط دستگاه گیرنده پشتیبانی می شود.

ارزش
VIDEO_OUT	رشته گیرنده از خروجی ویدیو پشتیبانی می کند.
خروجی صدا	رشته گیرنده از خروجی صدا پشتیبانی می کند.
VIDEO_IN	رشته گیرنده از ورودی ویدئو (دوربین) پشتیبانی می کند.
ورودی صدا	رشته گیرنده از ورودی صدا (میکروفون) پشتیبانی می کند.
MULTIZONE_GROUP	رشته گیرنده یک گروه چند منطقه ای را نشان می دهد.

DefaultActionPolicy

ایستا

رشته

خط‌مشی اقدام پیش‌فرض تعیین می‌کند که کی SDK به‌طور خودکار جلسه‌ای را پس از مقداردهی اولیه API ایجاد می‌کند. این همچنین عملکرد پیش‌فرض برگه را در پنجره بازشو کنترل می‌کند.

ارزش
CREATE_SESSION	رشته اگر هنگام راه اندازی API، برگه حاوی برنامه ارسال شود، SDK ارسال برگه را متوقف می کند و به طور خودکار برنامه را راه اندازی می کند. پنجره بازشو از کاربر می خواهد که برنامه را ارسال کند.
CAST_THIS_TAB	رشته هیچ راه اندازی خودکار پس از مقداردهی اولیه API انجام نمی شود، حتی اگر برگه در حال ارسال باشد. پنجره بازشو از کاربر می خواهد که برگه را ارسال کند.

DialAppState

ایستا

رشته

حالت های احتمالی یک برنامه DIAL.

ارزش
در حال اجرا	رشته
متوقف شد	رشته
خطا	رشته بخشی از مشخصات نیست، برای سیگنال دادن به خطاها استفاده می شود.

کد خطا

ایستا

رشته

خطاهایی که ممکن است توسط SDK برگردانده شوند.

ارزش
لغو	رشته این عملیات توسط کاربر لغو شد.
تایم اوت	رشته زمان عملیات تمام شد.
API_NOT_INITIALIZED	رشته API راه اندازی نشده است.
INVALID_PARAMETER	رشته پارامترهای عملیات معتبر نبودند.
EXTENSION_NOT_COMPATIBLE	رشته اسکریپت API با برنامه افزودنی Cast نصب شده سازگار نیست.
EXTENSION_MISSING	رشته برنامه افزودنی Cast در دسترس نیست.
RECEIVER_UNAVAILABLE	رشته هیچ گیرنده ای با درخواست جلسه سازگار نبود.
SESSION_ERROR	رشته یک جلسه ایجاد نشد یا یک جلسه نامعتبر بود.
CHANNEL_ERROR	رشته کانالی به گیرنده در دسترس نیست.
LOAD_MEDIA_FAILED	رشته رسانه بارگیری نشد.

موجود است

ایستا

بولی

برای بررسی اینکه آیا API بارگیری شده است، مشتریان را پرچم گذاری کنید.

ReceiverAction

ایستا

رشته

اقداماتی که کاربر می تواند روی یک گیرنده در برنامه افزودنی انجام دهد. اینها را می توان برای نشان دادن یک انتقال در رابط کاربری برنامه فرستنده قبل از تکمیل کامل (یا ناموفق) عمل ارسال استفاده کرد.

ارزش
قالب	رشته کاربر یک گیرنده را با هدف ارسال به آن با برنامه فرستنده انتخاب کرد. ممکن است هویت دقیق گیرنده مشخص نباشد.
متوقف کردن	رشته کاربر درخواست توقف اجرای جلسه روی گیرنده را داد.

ReceiverAvailability

ایستا

رشته

در دسترس بودن گیرنده Cast را شرح می دهد.

ارزش
در دسترس	رشته حداقل یک گیرنده در دسترس است که با درخواست جلسه سازگار باشد.
غیر قابل دسترسی	رشته هیچ گیرنده ای در دسترس نیست.

نوع گیرنده

ایستا

رشته

ارزش
قالب	رشته گیرنده Cast، به عنوان مثال Chromecast
شماره گیری	رشته دستگاه DIAL، به عنوان مثال تلویزیون هوشمند
Hangout	رشته پاتوق
سفارشی	رشته گیرنده سفارشی ارائه شده توسط مشتری

پلتفرم فرستنده

ایستا

رشته

یک پلت فرم برنامه فرستنده را توصیف می کند.

ارزش
CHROME	رشته
IOS	رشته
اندروید	رشته

وضعیت جلسه

ایستا

رشته

وضعیت یک جلسه Cast را در برنامه گیرنده آن شرح می دهد.

ارزش
متصل	رشته جلسه به برنامه گیرنده متصل است.
قطع شده	رشته ارتباط جلسه با برنامه گیرنده قطع شده است. برنامه گیرنده ممکن است هنوز در حال اجرا باشد یا نباشد.
متوقف شد	رشته برنامه گیرنده متوقف شده است.

تایم اوت

ایستا

chrome.cast.Timeout غیر تهی

مقادیر مهلت زمانی پیش‌فرض بر حسب میلی‌ثانیه برای روش‌های API.

VERSION

ثابت ثابت

آرایه اعداد غیر تهی

نسخه API. شماره اول نسخه اصلی و دومی نسخه فرعی است.

VolumeControlType

ایستا

رشته

انواع کنترل صدا را شرح می دهد.

ارزش
تضعیفی	رشته میزان صدای دستگاه Cast را می توان تغییر داد.
درست شد	رشته میزان صدای دستگاه Cast ثابت است و قابل تغییر نیست.
استاد	رشته کنترل صدا اصلی سیستم، یعنی صدای تلویزیون یا صدای دستگاه تغییر کرده است.

مواد و روش ها

addReceiverActionListener

ایستا

addReceiverActionListener(شنونده)

یک تابع شنونده اضافه می کند که وقتی کاربر از طریق رابط کاربری اقدام به شروع یا توقف ارسال محتوا کرده است، فراخوانی می شود. برنامه فرستنده می تواند از این برای نشان دادن یک انتقال در رابط کاربری خود استفاده کند (یعنی توقف پخش رسانه محلی) قبل از تکمیل یا شکست عملیات ارسال.

• شنونده تضمینی برای فراخوانی نیست و برنامه ها نباید برای عملکرد صحیح به آن متکی باشند.
• در صورت وجود، گیرنده ای که بر روی آن عمل شده است به شنونده منتقل می شود. با این حال ممکن است گیرنده شناخته نشده باشد و به جای آن null ارسال می شود.
• پس از اقدام کاربر، شنونده در اسرع وقت فراخوانی می شود. باید قبل از اینکه برنامه از تغییر وضعیت حاصل از طریق API مطلع شود، فراخوانی شود.

اگر از Framework API استفاده می کنید، به جای آن از cast.framework.CastContext#addEventListener استفاده کنید و به رویدادهای cast.framework.CastContextEventType#CAST_STATE_CHANGED گوش دهید.

پارامتر
شنونده	chrome.cast.ReceiverActionListener تابع شنونده برای اضافه کردن. اولین استدلال برای شنونده، گیرنده ای است که به آن عمل شده است. آرگومان دوم برای شنونده عملی است که درخواست شده است (به chrome.cast.ReceiverAction مراجعه کنید). مقدار نباید صفر باشد.

مقداردهی اولیه

ایستا

مقداردهی اولیه (apiConfig، successCallback، errorCallback)

API را راه اندازی می کند. توجه داشته باشید که هر دو موفقیتCallback و errorCallback پس از اتمام اولیه سازی API فراخوانی می شوند. sessionListener و receiverListener ممکن است در هر زمانی پس از آن و احتمالاً بیش از یک بار فراخوانی شوند.

اگر از Framework API استفاده می کنید، به جای این تابع از cast.framework.CastContext#setOptions استفاده کنید.

پارامتر
apiConfig	chrome.cast.ApiConfig شی با پارامترهایی برای مقداردهی اولیه API. مقدار نباید صفر باشد.
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی TIMEOUT، INVALID_PARAMETER، EXTENSION_MISSING هستند.

logMessage

ایستا

logMessage (پیام)

یک پیام اشکال زدایی را از برنامه ثبت می کند. این پیام ممکن است در یک گزارش بازخورد به Google ارسال شود اگر کاربران صریحاً بخواهند گزارش‌های دقیق را اضافه کنند.

پارامتر
پیام	رشته پیام ورود به سیستم

منسوخ

با Cast SDK مبتنی بر API Presentation پشتیبانی نمی‌شود.

پیش کش

ایستا

پیش کش (داده)

یک درخواست برای پیش کش داده ارسال کنید. اگر یک جلسه متصل باشد، یک درخواست مستقیم ارسال می کند، در غیر این صورت به تمام دستگاه های موجود در شبکه ارسال می شود.

پارامتر
داده ها	رشته داده برای پیش کش.

منسوخ

پشتیبانی نشده.

removeReceiverActionListener

ایستا

removeReceiverActionListener(شنونده)

یک تابع شنونده را که قبلاً با addReceiverActionListener اضافه شده بود حذف می کند.

پارامتر
شنونده	chrome.cast.ReceiverActionListener عملکرد شنونده برای حذف. مقدار نباید صفر باشد.

درخواست جلسه

ایستا

requestSession (successCallback، error Callback، sessionRequest)

درخواست می کند که یک جلسه برنامه گیرنده ایجاد یا ملحق شود. به طور پیش فرض، SessionRequest ارسال شده به API در زمان اولیه استفاده می شود. این ممکن است با ارسال یک درخواست جلسه دیگر در sessionRequest لغو شود.

اگر از Framework API استفاده می کنید، به جای این تابع از cast.framework.CastContext#requestSession استفاده کنید.

پارامتر
موفقیت تماس برگشتی	تابع (غیر تهی chrome.cast.Session )
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، INVALID_PARAMETER، API_NOT_INITIALIZED، CANCEL، CHANNEL_ERROR، SESSION_ERROR، RECEIVER_UNAVAILABLE، و EXTENSION_MISSING. توجه داشته باشید که زمان‌سنج پس از انتخاب گیرنده توسط کاربران شروع می‌شود. انتخاب گیرنده نیاز به اقدام کاربر دارد که هیچ مهلتی ندارد. اگر یک درخواست جلسه از قبل در حال انجام باشد، errorCallback با کد خطای INVALID_PARAMETER و توضیحاتی که خطا را توضیح می‌دهد فراخوانی می‌شود.
sessionRequest	اختیاری chrome.cast.SessionRequest مقدار نباید صفر باشد.

requestSessionById

ایستا

requestSessionById(sessionId)

درخواست برای پیوستن به یک جلسه موجود با شناسه داده شده. پس از پیوستن، جلسه به sessionListener تنظیم شده توسط chrome.cast.initialize منتقل می شود.

اگر جلسه با sessionId داده شده از قبل با فراخوانی این تابع شناخته شده باشد، sessionListener بلافاصله فراخوانی می شود. در غیر این صورت، هنگامی که یک جلسه با sessionId داده شده کشف شد، sessionListener فراخوانی می شود.

پارامتر
شناسه جلسه	رشته شناسه جلسه برای پیوستن.

setCustomReceivers

ایستا

setCustomReceivers (دریافت کننده ها، callback موفقیت، خطای Callback)

لیست گیرنده های سفارشی را تنظیم می کند

پارامتر
گیرنده ها	آرایه ای از chrome.cast.Receiver غیر تهی لیست جدید. مقدار نباید صفر باشد.
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، و EXTENSION_MISSRING.

منسوخ

با Cast SDK مبتنی بر API Presentation پشتیبانی نمی‌شود.

setPageContext

ایستا

setPageContext (برد)

عملکرد Cast را برای صفحه ای که Cast SDK را در iframe بارگیری می کند، راه اندازی می کند. باید پس از راه اندازی SDK فراخوانی شود.

پارامتر
پیروزی	پنجره شی پنجره صفحه. مقدار نباید صفر باشد.

setReceiverDisplayStatus

ایستا

setReceiverDisplayStatus (گیرنده، موفقیت تماس، پاسخ تماس خطا)

نام گیرنده و وضعیت نمایش را تنظیم می کند. برای نشان دادن گیرنده به صورت بیکار، displayStatus را روی null تنظیم کنید.

فقط برای گیرنده های سفارشی معتبر است. اگر این گیرنده CAST باشد، وضعیت نمایش گیرنده نادیده گرفته می شود. وضعیت گیرنده Cast توسط برنامه گیرنده به روز می شود.

پارامتر
گیرنده	chrome.cast.گیرنده گیرنده. مقدار نباید صفر باشد.
موفقیت تماس برگشتی	تابع() هنگامی که تنظیم وضعیت با موفقیت انجام می شود، تماس بگیرید.
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی TIMEOUT، INVALID_PARAMETER، API_NOT_INITIALIZED، و EXTENSION_MISSING هستند.

منسوخ

با Cast SDK مبتنی بر API Presentation پشتیبانی نمی‌شود.

فرار کردن

ایستا

unescape(escaped) رشته را برمی گرداند

روش کاربردی برای حذف رشته های URI-Escape شده. به عنوان مثال، نام مناسب گیرنده به عنوان یک رشته URI-escape شده برگردانده می شود. در صورت نیاز از این روش برای حذف آن رشته استفاده کنید.

پارامتر
فرار کرد	رشته رشته ای برای فرار

برمی گرداند

string بدون فرار

نوع انتزاعی

ReceiverActionListener

ایستا

ReceiverActionListener()