bunnynet_videolibrary extends deprecated_item
Legacy item deprecated_model class.
Table of Contents
Constants
- PERPAGE = 50
- STATUS_ACTIVE = 'active'
- STATUS_CANCELED = 'canceled'
- STATUS_COMPLETED = 'completed'
- STATUS_DELETED = 'deleted'
- STATUS_DISABLED = 'disabled'
- STATUS_DISAPPROVED = 'disapproved'
- STATUS_ENABLED = 'enabled'
- STATUS_EXPIRED = 'expired'
- STATUS_FAILED = 'failed'
- STATUS_FINISH = 'finish'
- STATUS_INACTIVE = 'inactive'
- STATUS_INPROGRESS = 'inprogress'
- STATUS_NEW = 'new'
- STATUS_PAUSED = 'paused'
- STATUS_PLAYED = 'played'
- STATUS_SYNC = 'sync'
- TYPE = 'bunnynet_videolibrary'
Properties
- $allowDirectPlay : bool
- Determines if direct play URLs are enabled for the library.
- $allowEarlyPlay : bool
- Determines if the Early-Play feature is enabled.
- $allowedReferrers : array<string|int, string>
- The list of allowed referrer domains allowed to access the library.
- $apiAccessKey : string
- The API access key for the library.
- $apiKey : string
- The API key used for authenticating with the video library.
- $bitrate1080p : int
- The bitrate used for encoding 1080p videos.
- $bitrate1440p : int
- The bitrate used for encoding 1440p videos.
- $bitrate2160p : int
- The bitrate used for encoding 2160p videos.
- $bitrate240p : int
- The bitrate used for encoding 240p videos.
- $bitrate360p : int
- The bitrate used for encoding 360p videos.
- $bitrate480p : int
- The bitrate used for encoding 480p videos.
- $bitrate720p : int
- The bitrate used for encoding 720p videos.
- $blockedReferrers : array<string|int, string>
- The list of blocked referrer domains blocked from accessing the library.
- $blockNoneReferrer : bool
- Determines if requests without a referrer are blocked.
- $captionsBackground : string
- The captions display background color.
- $captionsFontColor : string
- The captions display font color.
- $captionsFontSize : int
- The captions display font size.
- $contextid : mixed
- $controls : string
- The list of controls on the video player.
- $courseid : mixed
- $customHTML : string
- The custom HTML that is added into the head of the HTML player.
- $dateCreated : DateTime
- The date when the video library was created.
- $description : mixed
- $descriptionformat : mixed
- $enableContentTagging : bool
- Determines if content tagging should be enabled for this library.
- $enabledResolutions : string
- The comma separated list of enabled resolutions.
- $enableDRM : bool
- Determines if the MediaCage basic DRM is enabled.
- $enableMP4Fallback : bool
- Determines if the MP4 fallback feature is enabled.
- $enableTranscribing : bool
- Determines if the automatic audio transcribing is currently enabled for this zone.
- $enableTranscribingDescriptionGeneration : bool
- Determines if automatic transcribing description generation is currently enabled.
- $enableTranscribingTitleGeneration : bool
- Determines if automatic transcribing title generation is currently enabled.
- $fontFamily : string
- The captions font family.
- $fullname : string
- The name of the Video Library.
- $guid : mixed
- $hasWatermark : bool
- Determines if the video library has a watermark configured.
- $id : mixed
- $idnumber : int
- $keepOriginalFiles : bool
- Determines if the original video files should be stored after encoding.
- $parent : mixed
- $playerKeyColor : string
- The key color of the player.
- $playerTokenAuthenticationEnabled : bool
- Determines if player token authentication is enabled.
- $pullZoneId : int
- The ID of the connected underlying pull zone.
- $pullZoneType : int
- The pull zone type: 0 = Premium 1 = Volume Default: 1
- $readOnlyApiKey : string
- The read-only API key used for authenticating with the video library.
- $replicationRegions : array<string|int, string>
- The geo-replication regions of the underlying storage zone.
- $shortname : string
- $showHeatmap : bool
- Determines if the video watch heatmap should be displayed in the player.
- $sortorder : mixed
- $status : mixed
- $storageUsage : int
- The total amount of storage used by the library.
- $storageZoneId : int
- The ID of the connected underlying storage zone.
- $timecreated : mixed
- $timemodified : mixed
- $trafficUsage : int
- The amount of traffic usage this month.
- $transcribingCaptionLanguages : array<string|int, string>
- The list of languages that the captions will be automatically transcribed to.
- $type : mixed
- $uiLanguage : string
- The UI language of the player.
- $userid : mixed
- $usermodified : mixed
- $vastTagUrl : string
- The URL of the VAST tag endpoint for advertising configuration.
- $version : mixed
- $viAiPublisherId : string
- The vi.ai publisher id for advertising configuration.
- $videoCount : int
- The number of videos in the video library.
- $visible : mixed
- $watermarkHeight : int
- The height of the watermark (in %).
- $watermarkPositionLeft : int
- The left offset of the watermark position (in %).
- $watermarkPositionTop : int
- The top offset of the watermark position (in %).
- $watermarkVersion : int
- The version of the watermark.
- $watermarkWidth : int
- The width of the watermark (in %).
- $webhookUrl : string
- The webhook URL of the video library.
- $fillable : mixed
- $table : mixed
- $table_metadata : mixed
Methods
- __clone() : mixed
- __construct() : mixed
- Constructor.
- add_videolibrary() : void
- Cria uma nova biblioteca no Bunny.net.
- all() : array<string|int, mixed>
- create_or_update() : void
- create_video() : bunnynet_videos|false
- Cria um novo vídeo para a biblioteca.
- delete() : bool
- deleted() : bool
- disabled() : bool
- enabled() : bool
- get_all_metadata() : array<string, mixed>
- get_file() : mixed
- Get file associated with the model.
- get_fileurl() : mixed
- Get file URL.
- get_item_or_create() : deprecated_item
- Factory method to get existing or create a new item.
- get_items() : array<string|int, deprecated_item>
- get_items_by_metadata() : array<string|int, mixed>
- get_list() : array<int, array{id: mixed, name: mixed, videocount: mixed, storageusage: string, trafficusage: string, link: mixed}>
- get_meta() : mixed
- Get metadata value by key.
- get_path() : string|null
- get_records() : array<string|int, deprecated_model_interface>
- get_table() : string|null
- get_table_metadata() : string
- get_url() : moodle_url
- get_videos() : array<int, array{name: mixed, views: mixed, storagesize: string, thumbnail: mixed, link: mixed}>
- getVideoPlayData() : mixed
- Carrega um novo vídeo para a biblioteca.
- load() : void
- set_meta() : void
- Set metadata key-value pair.
- set_metas() : void
- Set multiple metadata key-value pairs.
- streammode_force_single() : void
- update() : static
- Update the model with form data.
- update_collections() : void
- Atualiza as coleções de uma biblioteca.
- update_videolibraries() : void
- Atualiza a listagem de bibliotecas.
- update_videolibrary() : void
- Atualiza única biblioteca de vídeos.
- update_videos() : void
- Atualiza os vídeos de uma biblioteca.
- upload_video() : bool|null
- Carrega um novo vídeo para a biblioteca.
- url_generator() : moodle_url
- Generate a URL based on the Symfony route name and parameters.
- webhook_url_generator() : moodle_url
- Generate a webhook URL.
- from_record() : static
- get() : false|mixed|stdClass
- Get record by ID.
- get_by_idnumber() : false|mixed|stdClass
- Get record by idnumber.
- save() : mixed
Constants
PERPAGE
public
mixed
PERPAGE
= 50
STATUS_ACTIVE
public
mixed
STATUS_ACTIVE
= 'active'
STATUS_CANCELED
public
mixed
STATUS_CANCELED
= 'canceled'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'completed'
STATUS_DELETED
public
mixed
STATUS_DELETED
= 'deleted'
STATUS_DISABLED
public
mixed
STATUS_DISABLED
= 'disabled'
STATUS_DISAPPROVED
public
mixed
STATUS_DISAPPROVED
= 'disapproved'
STATUS_ENABLED
public
mixed
STATUS_ENABLED
= 'enabled'
STATUS_EXPIRED
public
mixed
STATUS_EXPIRED
= 'expired'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'failed'
STATUS_FINISH
public
mixed
STATUS_FINISH
= 'finish'
STATUS_INACTIVE
public
mixed
STATUS_INACTIVE
= 'inactive'
STATUS_INPROGRESS
public
mixed
STATUS_INPROGRESS
= 'inprogress'
STATUS_NEW
public
mixed
STATUS_NEW
= 'new'
STATUS_PAUSED
public
mixed
STATUS_PAUSED
= 'paused'
STATUS_PLAYED
public
mixed
STATUS_PLAYED
= 'played'
STATUS_SYNC
public
mixed
STATUS_SYNC
= 'sync'
TYPE
public
mixed
TYPE
= 'bunnynet_videolibrary'
Properties
$allowDirectPlay
Determines if direct play URLs are enabled for the library.
public
bool
$allowDirectPlay
$allowEarlyPlay
Determines if the Early-Play feature is enabled.
public
bool
$allowEarlyPlay
$allowedReferrers
The list of allowed referrer domains allowed to access the library.
public
array<string|int, string>
$allowedReferrers
$apiAccessKey
The API access key for the library.
public
string
$apiAccessKey
$apiKey
The API key used for authenticating with the video library.
public
string
$apiKey
$bitrate1080p
The bitrate used for encoding 1080p videos.
public
int
$bitrate1080p
$bitrate1440p
The bitrate used for encoding 1440p videos.
public
int
$bitrate1440p
$bitrate2160p
The bitrate used for encoding 2160p videos.
public
int
$bitrate2160p
$bitrate240p
The bitrate used for encoding 240p videos.
public
int
$bitrate240p
$bitrate360p
The bitrate used for encoding 360p videos.
public
int
$bitrate360p
$bitrate480p
The bitrate used for encoding 480p videos.
public
int
$bitrate480p
$bitrate720p
The bitrate used for encoding 720p videos.
public
int
$bitrate720p
$blockedReferrers
The list of blocked referrer domains blocked from accessing the library.
public
array<string|int, string>
$blockedReferrers
$blockNoneReferrer
Determines if requests without a referrer are blocked.
public
bool
$blockNoneReferrer
$captionsBackground
The captions display background color.
public
string
$captionsBackground
$captionsFontColor
The captions display font color.
public
string
$captionsFontColor
$captionsFontSize
The captions display font size.
public
int
$captionsFontSize
$contextid
public
mixed
$contextid
$controls
The list of controls on the video player.
public
string
$controls
$courseid
public
mixed
$courseid
$customHTML
The custom HTML that is added into the head of the HTML player.
public
string
$customHTML
$dateCreated
The date when the video library was created.
public
DateTime
$dateCreated
$description
public
mixed
$description
$descriptionformat
public
mixed
$descriptionformat
= 0
$enableContentTagging
Determines if content tagging should be enabled for this library.
public
bool
$enableContentTagging
$enabledResolutions
The comma separated list of enabled resolutions.
public
string
$enabledResolutions
$enableDRM
Determines if the MediaCage basic DRM is enabled.
public
bool
$enableDRM
$enableMP4Fallback
Determines if the MP4 fallback feature is enabled.
public
bool
$enableMP4Fallback
$enableTranscribing
Determines if the automatic audio transcribing is currently enabled for this zone.
public
bool
$enableTranscribing
$enableTranscribingDescriptionGeneration
Determines if automatic transcribing description generation is currently enabled.
public
bool
$enableTranscribingDescriptionGeneration
$enableTranscribingTitleGeneration
Determines if automatic transcribing title generation is currently enabled.
public
bool
$enableTranscribingTitleGeneration
$fontFamily
The captions font family.
public
string
$fontFamily
$fullname
The name of the Video Library.
public
string
$fullname
Tags
$guid
public
mixed
$guid
$hasWatermark
Determines if the video library has a watermark configured.
public
bool
$hasWatermark
$id
public
mixed
$id
$idnumber
public
int
$idnumber
Tags
$keepOriginalFiles
Determines if the original video files should be stored after encoding.
public
bool
$keepOriginalFiles
$parent
public
mixed
$parent
$playerKeyColor
The key color of the player.
public
string
$playerKeyColor
$playerTokenAuthenticationEnabled
Determines if player token authentication is enabled.
public
bool
$playerTokenAuthenticationEnabled
$pullZoneId
The ID of the connected underlying pull zone.
public
int
$pullZoneId
$pullZoneType
The pull zone type: 0 = Premium 1 = Volume Default: 1
public
int
$pullZoneType
$readOnlyApiKey
The read-only API key used for authenticating with the video library.
public
string
$readOnlyApiKey
$replicationRegions
The geo-replication regions of the underlying storage zone.
public
array<string|int, string>
$replicationRegions
$shortname
public
string
$shortname
Tags
$showHeatmap
Determines if the video watch heatmap should be displayed in the player.
public
bool
$showHeatmap
$sortorder
public
mixed
$sortorder
= 0
$status
public
mixed
$status
= ''
$storageUsage
The total amount of storage used by the library.
public
int
$storageUsage
$storageZoneId
The ID of the connected underlying storage zone.
public
int
$storageZoneId
$timecreated
public
mixed
$timecreated
= 0
$timemodified
public
mixed
$timemodified
= 0
$trafficUsage
The amount of traffic usage this month.
public
int
$trafficUsage
$transcribingCaptionLanguages
The list of languages that the captions will be automatically transcribed to.
public
array<string|int, string>
$transcribingCaptionLanguages
$type
public
mixed
$type
$uiLanguage
The UI language of the player.
public
string
$uiLanguage
$userid
public
mixed
$userid
$usermodified
public
mixed
$usermodified
$vastTagUrl
The URL of the VAST tag endpoint for advertising configuration.
public
string
$vastTagUrl
$version
public
mixed
$version
$viAiPublisherId
The vi.ai publisher id for advertising configuration.
public
string
$viAiPublisherId
$videoCount
The number of videos in the video library.
public
int
$videoCount
$visible
public
mixed
$visible
= 1
$watermarkHeight
The height of the watermark (in %).
public
int
$watermarkHeight
$watermarkPositionLeft
The left offset of the watermark position (in %).
public
int
$watermarkPositionLeft
$watermarkPositionTop
The top offset of the watermark position (in %).
public
int
$watermarkPositionTop
$watermarkVersion
The version of the watermark.
public
int
$watermarkVersion
$watermarkWidth
The width of the watermark (in %).
public
int
$watermarkWidth
$webhookUrl
The webhook URL of the video library.
public
string
$webhookUrl
$fillable
protected
mixed
$fillable
= ['videoCount', 'trafficUsage', 'storageUsage', 'dateCreated', 'apiKey']
$table
protected
mixed
$table
= 'middag_items'
$table_metadata
protected
mixed
$table_metadata
= 'middag_itemmeta'
Methods
__clone()
public
__clone() : mixed
__construct()
Constructor.
public
__construct([mixed $id = null ]) : mixed
Parameters
- $id : mixed = null
add_videolibrary()
Cria uma nova biblioteca no Bunny.net.
public
static add_videolibrary(mixed $body) : void
Parameters
- $body : mixed
all()
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed>create_or_update()
public
static create_or_update(array<string|int, mixed> $videoLibrary) : void
Parameters
- $videoLibrary : array<string|int, mixed>
create_video()
Cria um novo vídeo para a biblioteca.
public
create_video(mixed $filename) : bunnynet_videos|false
Parameters
- $filename : mixed
Return values
bunnynet_videos|falsedelete()
public
delete() : bool
Return values
booldeleted()
public
deleted() : bool
Tags
Return values
booldisabled()
public
disabled() : bool
Return values
boolenabled()
public
enabled() : bool
Return values
boolget_all_metadata()
public
get_all_metadata() : array<string, mixed>
Return values
array<string, mixed>get_file()
Get file associated with the model.
public
get_file(mixed $context, mixed $component, mixed $filearea[, mixed $validimage = false ]) : mixed
Parameters
- $context : mixed
- $component : mixed
- $filearea : mixed
- $validimage : mixed = false
Tags
get_fileurl()
Get file URL.
public
static get_fileurl(mixed $file) : mixed
Parameters
- $file : mixed
get_item_or_create()
Factory method to get existing or create a new item.
public
static get_item_or_create(null|int|string $contextid[, string $type = '' ]) : deprecated_item
Parameters
- $contextid : null|int|string
- $type : string = ''
Tags
Return values
deprecated_itemget_items()
public
get_items(mixed $searchcriteria, mixed $page, mixed &$totalcount[, mixed $sort = '' ][, mixed $includedeleted = false ][, mixed $perpage = 0 ]) : array<string|int, deprecated_item>
Parameters
- $searchcriteria : mixed
- $page : mixed
- $totalcount : mixed
- $sort : mixed = ''
- $includedeleted : mixed = false
- $perpage : mixed = 0
Tags
Return values
array<string|int, deprecated_item>get_items_by_metadata()
public
get_items_by_metadata(array<string|int, mixed> $searchcriteriaitem, array<string|int, mixed> $searchcriteriameta, int $page, int &$totalcount[, null|string $sort = '' ][, bool $includedeleted = false ][, int $perpage = 0 ]) : array<string|int, mixed>
Migrate to core\repository\item_search_repository
Parameters
- $searchcriteriaitem : array<string|int, mixed>
- $searchcriteriameta : array<string|int, mixed>
- $page : int
- $totalcount : int
- $sort : null|string = ''
- $includedeleted : bool = false
- $perpage : int = 0
Tags
Return values
array<string|int, mixed>get_list()
public
static get_list() : array<int, array{id: mixed, name: mixed, videocount: mixed, storageusage: string, trafficusage: string, link: mixed}>
Return values
array<int, array{id: mixed, name: mixed, videocount: mixed, storageusage: string, trafficusage: string, link: mixed}>get_meta()
Get metadata value by key.
public
get_meta(mixed $meta_key) : mixed
Parameters
- $meta_key : mixed
Tags
get_path()
public
get_path() : string|null
Return values
string|nullget_records()
public
get_records(mixed $searchcriteria, mixed $page, mixed &$totalcount[, mixed $sort = '' ][, mixed $perpage = 0 ]) : array<string|int, deprecated_model_interface>
Parameters
- $searchcriteria : mixed
- $page : mixed
- $totalcount : mixed
- $sort : mixed = ''
- $perpage : mixed = 0
Tags
Return values
array<string|int, deprecated_model_interface>get_table()
public
get_table() : string|null
Return values
string|nullget_table_metadata()
public
get_table_metadata() : string
Return values
stringget_url()
public
get_url() : moodle_url
Return values
moodle_urlget_videos()
public
get_videos() : array<int, array{name: mixed, views: mixed, storagesize: string, thumbnail: mixed, link: mixed}>
Return values
array<int, array{name: mixed, views: mixed, storagesize: string, thumbnail: mixed, link: mixed}>getVideoPlayData()
Carrega um novo vídeo para a biblioteca.
public
getVideoPlayData(mixed $videoId[, mixed $query = [] ]) : mixed
Parameters
- $videoId : mixed
- $query : mixed = []
load()
public
load([mixed $reload = false ]) : void
Parameters
- $reload : mixed = false
set_meta()
Set metadata key-value pair.
public
set_meta(mixed $meta_key, mixed $meta_value) : void
Parameters
- $meta_key : mixed
- $meta_value : mixed
Tags
set_metas()
Set multiple metadata key-value pairs.
public
set_metas(array<string, mixed> $metas) : void
Parameters
- $metas : array<string, mixed>
streammode_force_single()
public
static streammode_force_single() : void
update()
Update the model with form data.
public
update([array<string, mixed> $formdata = [] ]) : static
Parameters
- $formdata : array<string, mixed> = []
Return values
staticupdate_collections()
Atualiza as coleções de uma biblioteca.
public
update_collections() : void
update_videolibraries()
Atualiza a listagem de bibliotecas.
public
static update_videolibraries() : void
update_videolibrary()
Atualiza única biblioteca de vídeos.
public
update_videolibrary() : void
update_videos()
Atualiza os vídeos de uma biblioteca.
public
update_videos() : void
upload_video()
Carrega um novo vídeo para a biblioteca.
public
upload_video(mixed $filename, mixed $filecontent) : bool|null
Parameters
- $filename : mixed
- $filecontent : mixed
Return values
bool|nullurl_generator()
Generate a URL based on the Symfony route name and parameters.
public
static url_generator(string $route[, array<string|int, mixed> $parameters = [] ][, int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH ]) : moodle_url
Parameters
- $route : string
- $parameters : array<string|int, mixed> = []
- $referenceType : int = UrlGeneratorInterface::ABSOLUTE_PATH
Return values
moodle_urlwebhook_url_generator()
Generate a webhook URL.
public
static webhook_url_generator(string $route[, array<string|int, mixed> $parameters = [] ][, int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH ]) : moodle_url
Parameters
- $route : string
- $parameters : array<string|int, mixed> = []
- $referenceType : int = UrlGeneratorInterface::ABSOLUTE_PATH
Return values
moodle_urlfrom_record()
protected
static from_record(stdClass $r) : static
Parameters
- $r : stdClass
Return values
staticget()
Get record by ID.
protected
get(mixed $id) : false|mixed|stdClass
Parameters
- $id : mixed
Tags
Return values
false|mixed|stdClassget_by_idnumber()
Get record by idnumber.
protected
get_by_idnumber(mixed $idnumber) : false|mixed|stdClass
Parameters
- $idnumber : mixed
Tags
Return values
false|mixed|stdClasssave()
protected
save() : mixed