---
title: "VideoBox (Video Objects Ex)"
canonical: "https://docs.cuesystem.com/space/CVCGC/490340387/VideoBox%20(Video%20Objects%20Ex)"
format: markdown
---
# Description

This object allows video playback. 

# Properties

See [Common section](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/490176564). In addition, this object uses the following properties.

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| URL | Text |  | Empty text | The source URL, can either be an audio/video file from units filestorage or a stream (HTTP and RTSP). |
| FullscreenControl | Boolean | True  
False | False | Specifies if a touch toggles fullscreen mode. |
| Appearance |
| FillColor | Long |  | _COLOR_BLACK | Background color when not playing |
| ShowURL | Boolean | True  
False | True | Specifies whether the URL text is shown. |
| LoadingAnimation | AddressOf _Animation |  | aniLoadingWhite | Specifies the animation that plays while waiting for the initial video load (there is also aniLoadingBlack for light backgrounds) |
| URLFont | AddressOf _Font |  | fntDefault16 | The URL font to use. (fntDefault16 is Verdana) |
| URLFontColor | Long |  | _COLOR_WHITE | The URL text color. |
| Opacity | Byte |  | 255 | Specifies the opacity of the entire object, even when playing video. |
| BorderColor | Long |  | &HFF484848 | The border color. |
| BorderWidth | Long | 0 to 8 | 2 | The border width. |

# Functions

See [Common section](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/490176564). In addition, this object uses the following functions.

## Play

Starts video playback. Function does nothing if already playing.

#### Syntax 

```visualbasic
Function Play()
```

## Stop

Stops video playback. Function does nothing if not playing or paused.

#### Syntax 

```visualbasic
Function Stop()
```

## Pause

Pauses video playback. Function does nothing if not playing.

> ℹ️ Firmware 21.40 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function Pause()
```

## Resume

Resumes video playback. Function does nothing if not paused.

> ℹ️ Firmware 21.40 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function Resume()
```

## IsPlaying

Returns if the video is currently playing.

> ℹ️ Firmware 21.40 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function IsPlaying() As Boolean
```

## IsPaused

Returns if the video is currently paused.

> ℹ️ Firmware 21.40 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function IsPaused() As Boolean
```

## GetVideoDimensions

This function returns video stream dimensions of the currently playing video. This information might not be always available for every source, some live sources return zeroes. Zeroes are also returned if the video is not playing.

> ℹ️ Firmware 15.00 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function GetVideoDimensions(ByRef width As Long, ByRef height As Long)
```

## GetPlayingTime

This function returns information about the current playback position and the total length of the video. The parameter total is set to a value '0' in the case of a live source. This function returns True if the video is playing and time values were available.

> ℹ️ Firmware 15.00 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

#### Syntax 

```visualbasic
Function GetPlayingTime(ByRef current As Time, ByRef total As Time) As Boolean
```

## SetURL

Sets URL property to given value. Does not affect currently playing video, for the new URL to take effect video must be stopped first.

URL examples:

|  |  |
| --- | --- |
| - /filestorage/CUENIUM2_800x450_h263p_3000.avi | (file stored in the unit) |
| - rtsp://169.254.0.99:554/live.sdp | (Vivotek IP camera) |
| - rtsp://192.168.0.90:554/mpeg4/1/media.amp | (Axis videoserver) |

#### Syntax 

```visualbasic
Function SetURL(newurl As Text)
```

## GetURL

Returns reference to the URL property text.

#### Syntax 

```visualbasic
Function GetURL() As AddressOf Text
```

## SetFullscreenControl

Sets FullscreenControl property.

#### Syntax 

```visualbasic
Function SetFullscreenControl(newval As Boolean)
```

## GetFullscreenControl

Returns FullscreenControl property.

#### Syntax 

```visualbasic
Function GetFullscreenControl() As Boolean
```

## SetFullscreen

Sets the object to cover the entire screen or back to previous values.

#### Syntax 

```visualbasic
Function SetFullscreen(newval As Boolean)
```

## IsFullscreen

Returns if the object is currently in fullscreen mode.

#### Syntax 

```visualbasic
Function IsFullscreen() As Boolean
```

## SetOpacity

Sets the opacity property. Changes are visible immediately.

#### Syntax 

```visualbasic
Function SetOpacity(newopacity As Byte)
```

## GetOpacity

Returns the opacity property.

#### Syntax 

```visualbasic
Function GetOpacity() As Byte
```

# Events

## OnTouch

This event is generated when the object is touched.

#### Syntax 

```visualbasic
Event OnTouch As Process()
```

## OnPlaybackStop

This event is invoked by system when video playback is stopped.

> ℹ️ Firmware 15.00 or later is required and panels in revision R22 or higher are required. The current version of appCUE does not have this feature implemented.

Values of reasons and their explanation:

- 1 – playback was stopped because command Video.Stop was called
- 2 – playback was stopped because end of file was reached
- 3 – playback was stopped because some error in source stream occurred

#### Syntax 

```visualbasic
Event OnPlaybackStop(reason As Long)
```