75 lines
2.1 KiB
PHP
75 lines
2.1 KiB
PHP
<?php
|
|
/*
|
|
* Copyright (C) 2023 Xibo Signage Ltd
|
|
*
|
|
* Xibo - Digital Signage - https://xibosignage.com
|
|
*
|
|
* This file is part of Xibo.
|
|
*
|
|
* Xibo is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* Xibo is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with Xibo. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace Xibo\XMR;
|
|
|
|
/**
|
|
* Class OverlayLayoutAction
|
|
* @package Xibo\XMR
|
|
*/
|
|
class OverlayLayoutAction extends PlayerAction
|
|
{
|
|
public $layoutId;
|
|
public $duration;
|
|
public $downloadRequired;
|
|
public $changeMode;
|
|
|
|
public function __construct()
|
|
{
|
|
$this->setQos(10);
|
|
}
|
|
|
|
/**
|
|
* Set details for this layout
|
|
* @param int $layoutId the layoutId to change to
|
|
* @param int $duration the duration this layout should be overlaid
|
|
* @param bool|false $downloadRequired flag indicating whether a download is required before changing to the layout
|
|
* @return $this
|
|
*/
|
|
public function setLayoutDetails($layoutId, $duration, $downloadRequired = false)
|
|
{
|
|
$this->layoutId = $layoutId;
|
|
$this->duration = $duration;
|
|
$this->downloadRequired = $downloadRequired;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function getMessage(): string
|
|
{
|
|
$this->action = 'overlayLayout';
|
|
|
|
if ($this->layoutId == 0) {
|
|
throw new PlayerActionException(__('Layout Details not provided'));
|
|
}
|
|
|
|
if ($this->duration == 0) {
|
|
throw new PlayerActionException(__('Duration not provided'));
|
|
}
|
|
|
|
return $this->serializeToJson(['layoutId', 'duration', 'downloadRequired']);
|
|
}
|
|
}
|