Cannot specify widget duration with API

ken · September 11, 2019, 5:31am

Hi,everybody

I have a question about specifing widget duration with API

I’m using xibo-cms2.0.4 .

When I assigned images to playlist with API, I specified duration of image widget.
But this value in responce is not specified duration by me.
That is value of image widget. (now I’m setting it 20sec.)

Am I forgetting somthing about that?

(Sorry for lack of English skill.)

Peter · September 11, 2019, 12:22pm

The playlist/library/assign API call, takes an array of mediaIds, however it takes one duration and useDuration parameter that will be applied to all widgets assigned in this call.

That said, we seem to have a bug where the duration reverts to the Module default duration.

github.com

xibosignage/xibo-cms/blob/release20/lib/Controller/Playlist.php#L922


$widget = $this->widgetFactory->create($this->getUser()->userId, $playlistId, $item->mediaType, $itemDuration);
$widget->assignMedia($item->mediaId);


// Assign the widget to the module
$module->setWidget($widget);


// Set default options (this sets options on the widget)
$module->setDefaultWidgetOptions();


// If a duration has been provided, then we want to use it, so set useDuration to 1.
if ($duration !== null || $this->getSanitizer()->getCheckbox('useDuration') == 1)
    $widget->useDuration = 1;


// Calculate the duration
$widget->calculateDuration($module);


// Assign the widget to the playlist
$playlist->assignWidget($widget);


// Add to a list of new widgets
$newWidgets[] = $widget;

The $module->setDefaultWidgetOptions() will set the useDuration to 0 and duration to the default duration set on the module (Image module in this case).

While we do set the $widget->useDuration = 1 if it was provided in the call, we do not do that with the duration, hence why it’s not correctly set.

it should be just the case of editing the highlighted condition to say the following:

            if ($duration !== null || $this->getSanitizer()->getCheckbox('useDuration') == 1) {
                $widget->useDuration = 1;
                $widget->duration = $itemDuration;
            }

Alternatively you can edit the Image widget after it was assigned with PUT /playlist/widget/{widgetId} and set the duration there.

ken · September 12, 2019, 4:13am

Hi,Peter.
Thank you for comment.

I confirmed that each two solutions that you suggested was right.
It worked!

And I did one misunderstanding.
“duration” and “useDuration” are not array. So “[]” was unnecessary.

Thank you for quick and detailed answer.