قالب. چارچوب . (cast. framework) مدیر پخش
پخش رسانه را کنترل و نظارت میکند.
- پرتابها
non-null Errorاگر سازنده مستقیماً استفاده شود.PlayerManagerفقط باید با فراخوانی cast.framework.CastReceiverContext#getPlayerManager قابل دسترسی باشد.
روشها
addEventListener
addEventListener (EventType، eventListener)
یک شنونده رویداد اضافه میکند که به رویدادهای پخش گوش میدهد.
پارامتر | |
|---|---|
نوع رویداد | (نوع رویداد غیر تهی cast.framework.events.EventType یا آرایه غیر تهی از نوع رویداد غیر تهی cast.framework.events.EventType ) یک نوع رویداد یا آرایهای از انواع رویدادها |
شنونده رویداد | تابع ( cast.framework.events.Event غیر تهی) |
- پرتابها
non-null Errorاگر آرگومانهای داده شده معتبر نباشند.
دستورات رسانهای پشتیبانیشده را اضافه کنید
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
دستورات پشتیبانیشدهی جدید را به لیست موجود دستورات رسانهای پشتیبانیشده اضافه میکند.
پارامتر | |
|---|---|
دستورات پشتیبانیشدهی مدیا | شماره یک ماسک بیتی از دستورات رسانهای پشتیبانی شده توسط برنامه. |
وضعیت پخش | اختیاری بولی |
- همچنین ببینید
- دستور cast.framework.messages
وضعیت پخش
وضعیت پخش (شامل رسانه، شناسه درخواست، دادههای سفارشی، شامل موارد صف)
یک پیام وضعیت رسانه را به همه فرستندگان ارسال میکند (پخش). برنامهها از این برای ارسال تغییر وضعیت سفارشی استفاده میکنند.
پارامتر | |
|---|---|
شامل رسانه | اختیاری بولی |
شناسه درخواست | اختیاری شماره شناسه درخواست ورودی که باعث این پاسخ شده است. |
دادههای سفارشی | اختیاری شیء دادههای سفارشی مخصوص برنامه پیام وضعیت. مقدار ممکن است تهی (null) باشد. |
شامل موارد صف | اختیاری بولی اینکه آیا موارد صف در پیام وضعیت گنجانده شوند یا خیر. به طور پیشفرض، آنها گنجانده نمیشوند. |
دریافت زمان مطلق برای رسانه ها
تابع getAbsoluteTimeForMediaTime(mediaTime) عدد را برمیگرداند.
زمان رسانه را به زمان مطلق رسانه تبدیل میکند. زمان مطلق فقط برای پخش زنده قابل استفاده است.
پارامتر | |
|---|---|
مدیا تایم | شماره وقت رسانه. |
- بازگشتها
nullable numberزمان مطلق یا در صورت عدم وجودnull.
دریافتکنندهی آهنگهای صوتی
تابع ()getAudioTracksManager مقدار cast.framework.AudioTracksManager را برمیگرداند.
نمونهی AudioTracksManager را دریافت میکند.
- بازگشتها
non-null cast.framework.AudioTracksManager
دریافت BreakClipCurrentTimeSec
تابع ()getBreakClipCurrentTimeSec عدد را برمیگرداند.
زمان فعلی کلیپ break که در حال پخش است را بر حسب ثانیه برمیگرداند.
- بازگشتها
nullable numberزمان فعلی به ثانیه در داخل کلیپ break فعلی.nullزمانی کهPlayerکلیپ break را پخش نمی کند.
دریافت BreakClipDurationSec
تابع ()getBreakClipDurationSec عدد را برمیگرداند.
مدت زمان کلیپ در حال پخش را بر حسب ثانیه برمیگرداند.
- بازگشتها
nullable numberمدت زمان کلیپ break فعلی.nullزمانی کهPlayerکلیپ break را پخش نمی کند.
دریافت مدیر
تابع ()getBreakManager مقدار cast.framework.breaks.BreakManager را برمیگرداند.
نمونه BreakManager را دریافت میکند.
- بازگشتها
non-null cast.framework.breaks.BreakManager
دریافتها
تابع ()getBreaks آرایهای از نوع cast.framework.messages.Break غیر تهی را برمیگرداند.
لیستی از وقفهها را برمیگرداند.
- بازگشتها
non-null Array of non-null cast.framework.messages.Break
دستورات رسانهای پشتیبانیشدهی فعلی
تابع ()getCurrentSupportedMediaCommands عدد را برمیگرداند.
دستورات رسانهای پشتیبانیشده توسط گیرنده فعلی را دریافت میکند. برخلاف getSupportedMediaCommands() ، مقدار بازگشتی این متد به صورت پویا بر اساس وضعیت پخش فعلی تغییر میکند. برای مثال، در طول پخش تبلیغات، ممکن است دستور SEEK پشتیبانی نشود. این متد فقط باید پس از فراخوانی گیرنده CastReceiverContext#start فراخوانی شود، در غیر این صورت 0 برمیگرداند.
- همچنین ببینید
- دستور cast.framework.messages
- بازگشتها
numberیک ماسک بیتی از دستورات رسانهای پشتیبانی شده توسط برنامه.
دریافت زمان و ثانیه فعلی
تابع ()getCurrentTimeSec عدد را برمیگرداند.
زمان پخش سپریشده از رسانهی فعلی را دریافت میکند.
- بازگشتها
numberزمان سپری شده، بر حسب ثانیه. اگر هیچ رسانهای در حال پخش نباشد، این مقدار0خواهد بود.
دریافت مدت زمان امنیت (getDurationSec)
تابع ()getDurationSec عدد را برمیگرداند
مدت زمان پخش رسانهی در حال پخش را بر حسب ثانیه دریافت میکند.
- بازگشتها
numberمدت زمان پخش رسانه. اگر هیچ رسانهای در حال پخش نباشد،NaNبود.
محدودهی قابل جستجوی زندهی زنده
تابع ()getLiveSeekableRange ، تابع cast.framework.messages.LiveSeekableRange را برمیگرداند.
محدوده جستجوی زنده را به همراه زمان شروع و زمان پایان بر حسب ثانیه برمیگرداند. مقادیر بر اساس زمان رسانه هستند.
- بازگشتها
دریافت اطلاعات رسانهای
تابع ()getMediaInformation، تابع cast.framework.messages.MediaInformation را برمیگرداند.
اطلاعات رسانهای رسانههای فعلی را دریافت میکند.
- بازگشتها
دریافت زمان رسانهای برای زمان مطلق
تابع getMediaTimeForAbsoluteTime(absoluteTime) عدد را برمیگرداند.
زمان مطلق رسانه را به زمان رسانه تبدیل میکند. زمان مطلق فقط برای پخش زنده قابل استفاده است.
پارامتر | |
|---|---|
مطلق زمان | شماره زمان مطلق رسانه، به عنوان زمان عصر یونیکس (ثانیهها از عصر یونیکس). |
- بازگشتها
nullable numberزمان رسانه یا در صورت عدم وجود،null.
پیکربندی getPlayback
getPlaybackConfig() مقدار cast.framework.PlaybackConfig را برمیگرداند.
پیکربندی پخش را برمیگرداند یا اگر پیشفرضها لغو نشده باشند، null برمیگرداند.
- بازگشتها
nullable cast.framework.PlaybackConfig
دریافت نرخ پخش
تابع ()getPlaybackRate عدد را برمیگرداند.
نرخ پخش فعلی را برمیگرداند. قبل از اینکه گیرنده CastReceiverContext#start فراخوانی شود، 1 را برمیگرداند.
- بازگشتها
numberنرخ پخش فعلی.
دریافت وضعیت پخشکننده
تابع ()getPlayerState مقدار cast.framework.messages.PlayerState را برمیگرداند.
وضعیت Player را دریافت میکند.
- بازگشتها
non-null cast.framework.messages.PlayerStateوضعیتPlayerفعلی.
نرخ پخش ترجیحی را دریافت کنید
تابع ()getPreferredPlaybackRate عدد را برمیگرداند.
نرخ پخش ترجیحی را دریافت کنید. میتواند در رویداد خاموش شدن برای ذخیره آخرین نرخ پخش ترجیحی در حافظه دائمی استفاده شود، بنابراین میتوان آن را در جلسه بعدی در گزینههای پخش استفاده کرد.
- بازگشتها
number
زبان متن ترجیحی را دریافت کنید
تابع ()getPreferredTextLanguage رشته را برمیگرداند.
زبان آهنگ متن ترجیحی را دریافت میکند.
- بازگشتها
nullable string
getPreferredTextStyle
تابع ()getPreferredTextStyle مقدار cast.framework.messages.TextTrackStyle را برمیگرداند.
سبک آهنگ متن ترجیحی را دریافت میکند.
- بازگشتها
getQueueManager
تابع ()getQueueManager مقدار ( cast.framework.QueueManager یا undefined) را برمیگرداند.
نمونهی QueueManager را دریافت میکند.
- بازگشتها
(non-null cast.framework.QueueManager or undefined)
دریافتRawCurrentTimeSec
تابع ()getRawCurrentTimeSec عدد را برمیگرداند.
زمان پخش سپریشده از رسانه فعلی را بدون کم کردن زمان پخش تبلیغات، دریافت میکند.
- بازگشتها
numberزمان سپری شده، بر حسب ثانیه. اگر هیچ رسانهای در حال پخش نباشد، این مقدار0خواهد بود.
getRawSeekableRange
تابع ()getRawSeekableRange، تابع cast.framework.messages.Range را برمیگرداند.
محدودهی جستجوی فعلی رسانه را برمیگرداند.
نکته: این با واحدهای getRawCurrentTimeSec() مطابقت دارد، اما seek() مطابقت ندارد!. این تابع، تبلیغات یا هرگونه جابجایی رسانهای دیگر را در نظر نمیگیرد. مگر اینکه مطمئن باشید به مقادیر خام نیاز دارید، در غیر این صورت باید از getLiveSeekableRange() استفاده کنید.
- بازگشتها
nullable cast.framework.messages.Range
دریافت زمان مطلق (getStartAbsoluteTime)
تابع ()getStartAbsoluteTime عدد را برمیگرداند.
زمان شروع پخش رسانه را به صورت مطلق، به عنوان زمان UNIX Epoch (ثانیه از زمان Unix Epoch) دریافت میکند. زمان مطلق فقط برای پخش زنده قابل استفاده است.
- بازگشتها
nullable number
دریافت آمار
تابع ()getStats، تابع cast.framework.stats.Stats را برمیگرداند.
آمار پخش را برمیگرداند. در صورت لزوم، آمار در کل جلسه پخش جمعآوری میشود.
- بازگشتها
non-null cast.framework.stats.Stats
دستورات رسانهای پشتیبانیشده
تابع ()getSupportedMediaCommands عدد را برمیگرداند.
دستورات رسانهای پشتیبانیشده توسط گیرنده را دریافت میکند. فقط باید پس از فراخوانی CastReceiverContext#start() فراخوانی شود، در غیر این صورت 0 را برمیگرداند. مقدار دستورات رسانهای پشتیبانیشده صرفاً توسط برنامه گیرنده کنترل میشود. این مقدار به طور خودکار بر اساس MediaStatus بهروزرسانی نمیشود.
- همچنین ببینید
- دستور cast.framework.messages
- بازگشتها
numberیک ماسک بیتی از دستورات رسانهای پشتیبانی شده توسط برنامه.
getTextTracksManager
تابع ()getTextTracksManager مقدار cast.framework.TextTracksManager را برمیگرداند.
نمونهی TextTracksManager را دریافت میکند.
- بازگشتها
non-null cast.framework.TextTracksManager
فرادادهی زمانبندیشده
تابع ()getTimedMetadata آرایهای از نوع دادهی غیر تهی (non-null) از نوع دادهی cast.framework.TimedMetadata را برمیگرداند.
فرادادههای زمانبندیشدهای را که در طول تجزیه مانیفست با آنها مواجه میشوید، برمیگرداند. این در HLS #EXT-X-DATERANGE و در DASH EventStream است.
- بازگشتها
non-null Array of non-null cast.framework.TimedMetadata
بار
load(loadRequest) مقدار Promise حاوی void را برمیگرداند.
درخواستی برای بارگذاری رسانه آغاز میکند.
پارامتر | |
|---|---|
درخواست بارگذاری | قالببندی.چارچوب.پیامها.بارگذاری دادههای درخواستی درخواستی برای بارگذاری یک رسانه. مقدار نباید تهی (null) باشد. |
- بازگشتها
non-null Promise containing voidکه در صورت موفقیت عملیات حل میشود، یا در صورت شکست رد میشود.
مکث
مکث ()
رسانه در حال پخش را متوقف میکند.
بازی کردن
بازی()
رسانهای که در حال حاضر متوقف شده است را پخش میکند.
حذف رویدادشن (removeEventListener)
removeEventListener(نوع رویداد، eventListener)
شنوندهی رویداد اضافه شده برای یک رویداد پخش مشخص را حذف میکند. اگر شنوندهی رویداد منطبقی وجود نداشته باشد، این فراخوانی نادیده گرفته میشود.
پارامتر | |
|---|---|
نوع رویداد | (نوع رویداد غیر تهی cast.framework.events.EventType یا آرایه غیر تهی از نوع رویداد غیر تهی cast.framework.events.EventType ) یک نوع رویداد یا آرایهای از انواع رویداد |
شنونده رویداد | تابع ( cast.framework.events.Event غیر تهی) |
دستورات رسانهای پشتیبانیشده را حذف کنید
دستورهای رسانهای پشتیبانیشده را حذف کنید(دستورهای رسانهای پشتیبانیشده، وضعیت پخش)
دستورات را از لیست دستورات رسانهای پشتیبانیشده حذف کنید.
پارامتر | |
|---|---|
دستورات پشتیبانیشدهی مدیا | شماره یک ماسک بیتی از دستورات رسانهای پشتیبانی شده توسط برنامه. |
وضعیت پخش | اختیاری بولی |
- همچنین ببینید
- دستور cast.framework.messages
جستجو کردن
جستجو (زمان جستجو)
در رسانههای فعلی جستجو میکند.
پارامتر | |
|---|---|
جستجوزمان | شماره |
ارسال وضعیت سفارشی
ارسال وضعیت سفارشی (وضعیت)
یک وضعیت سفارشی از منطق پخش برنامه به منطق رابط کاربری ارسال میکند. این روش به جداسازی منطق پخش و رابط کاربری کمک میکند. حفظ جداسازی بین منطق و رابط کاربری به فرد اجازه میدهد تا از منطق رابط کاربری یکسانی هم برای پخش محلی و هم برای کنترل از راه دور استفاده کند. وضعیت سفارشی ارسال شده توسط این روش از طریق PlayerData در دسترس رابط کاربری قرار میگیرد.
پارامتر | |
|---|---|
ایالت | شیء شیء حالت سفارشی. مقدار نباید تهی (null) باشد. |
- همچنین ببینید
- cast.framework.ui.PlayerData#customState
خطای ارسال
sendError(senderId, requestId, type, reason, customData)
خطایی را به فرستنده خاصی ارسال میکند.
پارامتر | |
|---|---|
شناسه فرستنده | رشته شناسه فرستنده. |
شناسه درخواست | شماره شناسه درخواست ورودی که باعث ایجاد این خطا شده است. |
نوع | نوع خطا در قالب قالببندی.پیامها.قالببندی نوع خطا. مقدار نباید تهی (null) باشد. |
دلیل | اختیاری قالببندی.چارچوب.پیامها.دلیل خطا دلیل خطا. مقدار ممکن است تهی (null) باشد. |
دادههای سفارشی | اختیاری شیء دادههای سفارشی مخصوص برنامهی کاربردی در پیام خطا. مقدار ممکن است تهی (null) باشد. |
ارسال درخواست رسانه محلی
ارسال درخواست رسانه محلی (درخواست)
درخواستی برای رسانههای محلی ارسال میکند.
پارامتر | |
|---|---|
درخواست | قالببندی.چارچوب.پیامها.درخواستداده مقدار نباید تهی (null) باشد. |
ارسال وضعیت
وضعیت ارسال (شناسه فرستنده، شناسه درخواست، شامل رسانه، دادههای سفارشی، شامل موارد صف)
یک پیام وضعیت رسانه را به یک فرستنده خاص ارسال میکند.
پارامتر | |
|---|---|
شناسه فرستنده | رشته شناسه فرستنده. |
شناسه درخواست | شماره شناسه درخواست ورودی که باعث این پاسخ شده است. |
شامل رسانه | اختیاری بولی |
دادههای سفارشی | اختیاری شیء دادههای سفارشی مخصوص برنامه پیام وضعیت. مقدار ممکن است تهی (null) باشد. |
شامل موارد صف | اختیاری بولی اینکه آیا موارد صف در پیام وضعیت گنجانده شوند یا خیر. به طور پیشفرض، آنها گنجانده نمیشوند. |
دلیل بیهدف
دلیل بیکاری (idleReason) را تنظیم کنید
دلیل قرار گرفتن پخشکننده در حالت IDLE را تنظیم میکند. این به برنامههایی که میخواهند حالت IDLE را اجباری کنند، اجازه میدهد دلیل انجام این کار را نشان دهند (برای مثال، یک خطای سفارشی). دلیل غیرفعال بودن در پیام وضعیت بعدی ارسال میشود. توجه: اکثر برنامهها نیازی به تنظیم این مقدار ندارند. فقط در صورتی لازم است که برنامه نیاز داشته باشد Player در شرایط خاص به حالت IDLE ببرد و مقدار پیشفرض idleReason رفتار مورد نظر را منعکس نکند.
پارامتر | |
|---|---|
دلیل بیکاری | قالببندی.چارچوب.پیامها.دلیل بیکار دلیل قرار گرفتن در حالت مقدار نباید تهی (null) باشد. |
عنصر setMedia
عنصر رسانه (عنصر رسانه)
عنصر HTMLMediaElement برای استفاده تنظیم میکند. اگر Promise مربوط به یک HTMLMediaElement تنظیم شده باشد، پخش رسانه پس از اتمام Promise آغاز میشود.
پارامتر | |
|---|---|
عنصر رسانه | (HTMLMediaElement غیر تهی یا Promise غیر تهی حاوی HTMLMediaElement غیر تهی) |
اطلاعات رسانهای تنظیمشده
تنظیم اطلاعات رسانهای(اطلاعات رسانهای، opt_broadcast)
اطلاعات رسانه را تنظیم میکند.
پارامتر | |
|---|---|
اطلاعات رسانهای | قالببندی.چارچوب.پیامها.اطلاعات رسانه مقدار نباید تهی (null) باشد. |
opt_broadcast | اختیاری بولی |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
یک هندلر را برای برگرداندن یا تغییر دادن cast.framework.PlaybackConfig برای یک درخواست بارگذاری خاص تنظیم میکند. پارامترهای هندلر عبارتند از LoadRequestData و PlaybackConfig پیشفرض برای گیرنده (که در CastReceiverOptions ارائه شده است). هندلر باید یک پیکربندی پخش اصلاحشده یا null را برگرداند تا از پخش رسانه جلوگیری شود. مقدار برگشتی همچنین میتواند یک Promise باشد تا امکان انتظار برای دادهها از سرور را فراهم کند.
پارامتر | |
|---|---|
رسیدگی کننده | تابع ( cast.framework.messages.LoadRequestData غیر تهی، cast.framework.PlaybackConfig غیر تهی) تابعی برای ارائه پیکربندی پخش خاص یک درخواست. مقدار ممکن است تهی (null) باشد. |
setMediaUrlResolver
setMediaUrlResolver(حلکننده)
یک هندلر برای برگرداندن آدرس اینترنتی رسانه برای درخواست LOAD تنظیم میکند. این هندلر میتواند برای جلوگیری از انتشار آدرس اینترنتی محتوای رسانه به عنوان بخشی از وضعیت رسانه استفاده شود. به طور پیشفرض، از contentId رسانه به عنوان آدرس اینترنتی محتوا استفاده میشود.
پارامتر | |
|---|---|
حل کننده | تابع ( cast.framework.messages.LoadRequestData غیر تهی) تابعی برای حل URL محتوای رسانه. مقدار ممکن است تهی (null) باشد. |
رهگیر setMessage
setMessageInterceptor(نوع، رهگیر)
یک رهگیر برای پیامهای ورودی و خروجی تنظیم میکند. رهگیر میتواند دادههای درخواست را بهروزرسانی کند و باید یا دادههای بهروزرسانیشده، یک Promise با دادههای بهروزرسانیشده (اگر دادهها بلافاصله قابل بازگشت نباشند) یا null در صورتی که درخواست نباید مدیریت شود، برگرداند. توجه : اگر یک رهگیر پیام LOAD ارائه شده باشد، اما هیچ رهگیر PRELOAD جداگانهای ارائه نشده باشد، رهگیر LOAD برای پیامهای PRELOAD فراخوانی میشود.
پارامتر | |
|---|---|
نوع | قالببندی.چارچوب.پیامها.نوع پیام مقدار نباید تهی (null) باشد. |
رهگیر | تابع ( cast.framework.messages.RequestData غیر تهی) مقدار ممکن است تهی (null) باشد. |
پیکربندی setPlayback
setPlaybackConfig(پیکربندی پخش)
پیکربندی پخش را در PlayerManager تنظیم میکند.
پارامتر | |
|---|---|
پیکربندی پخش | مقدار نباید تهی (null) باشد. |
دستورات رسانهای پشتیبانیشده را تنظیم کنید
setSupportedMediaCommands(دستورات رسانهای پشتیبانیشده، وضعیت پخش)
دستورات رسانهای پشتیبانیشده توسط گیرنده را تنظیم میکند.
پارامتر | |
|---|---|
دستورات پشتیبانیشدهی مدیا | شماره یک ماسک بیتی از دستورات رسانهای پشتیبانی شده توسط برنامه. |
وضعیت پخش | اختیاری بولی |
- همچنین ببینید
- دستور cast.framework.messages
متوقف کردن
توقف ()
رسانه در حال پخش را متوقف میکند.