ToiRecordedContentSource

Method Summary

copy ( callbacks , parameters ) → operation	Copies the selected range of DVR data from the one recorded content to a new recorded content in the same content location. When the operation has completed, the operation result contains the new content information.
create ( callbacks ) → operation	Creates a new content entry to be used for a recording activity. When the operation has completed, the operation result contains the new content information.

Inherited Methods

addEventListener ( type , listener )	This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.
getInfo ( ) → info	Returns source information.
releaseInstance ( )	This method shall be called when the source instance will no longer be used. Any subscribers to notifications from this source will be unsubscribed.
removeEventListener ( type , listener )	This method removes an event listener for a specific event.

Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Inherited From:

ToiEventTarget#addEventListener

Parameters:

Name	Type	Description
`type`	number	The event type of the event to subscribe to.
`listener`	ToiEventListener	The JavaScript function that will receive events.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.

copy ( callbacks , parameters ) → operation

Copies the selected range of DVR data from the one recorded content to a new recorded content in the same content location. When the operation has completed, the operation result contains the new content information.

Parameters:

Name	Type	Description
`callbacks`	AsyncCallback	Object with callback functions for the asynchronous operation. The callbacks.onResult() will be invoked with any incremental results of type ToiContentService.ToiContentInfo. The final and accumulated result will be available as the property 'result' in the operation object after callbacks.onCompleted() has been invoked.
`parameters`	ToiRecordedContentSource.ToiCopyParameters	The copy operation parameters.

Throws:

ToiInvalidArgumentException

Raised if

the operation identifier is invalid.
the content identifier is invalid.
duration is equal to zero.

ToiInvalidPreconditionException

Raised if the source is not available anymore.

ToiPermissionDeniedException

Raised if not supported due to license limitations.

Returns:

operation The asynchronous operation created by the function.

Type: ToiAsynchronousOperation

create ( callbacks ) → operation

Creates a new content entry to be used for a recording activity. When the operation has completed, the operation result contains the new content information.

Parameters:

Name	Type	Description
`callbacks`	AsyncCallback	Object with callback functions for the asynchronous operation. The callbacks.onResult() will be invoked with any incremental results of type ToiContentService.ToiContentInfo. The final and accumulated result will be available as the property 'result' in the operation object after callbacks.onCompleted() has been invoked.

Throws:

ToiInvalidArgumentException	Raised if the operation identifier is invalid.
ToiInvalidPreconditionException	Raised if the source is not available anymore.

Returns:

operation The asynchronous operation created by the function.

Type: ToiAsynchronousOperation

getInfo ( ) → info

Returns source information.

Inherited From:

ToiContentSource#getInfo

Returns:: the detailed information about the source.

Type: ToiContentService.ToiSourceInfo

releaseInstance ( )

This method shall be called when the source instance will no longer be used. Any subscribers to notifications from this source will be unsubscribed.

Inherited From:

ToiContentSource#releaseInstance

removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Inherited From:

ToiEventTarget#removeEventListener

Parameters:

Name	Type	Description
`type`	number	The event type of the event to remove the listener from.
`listener`	ToiEventListener	The JavaScript function that was previously added as an event listener.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener has not previously been added.

Members

ToiCopyParameters (Type: struct) (static)

Defines a structure with parameters used in a content copy operation

Struct fields

Name	Description
contentId	The content identifier of the recorded content to copy from. Type: ToiContentService.ToiContentId
duration [optional]	The duration (in milliseconds) to be copied. If specified; the value will be clamped to the remaining source content duration. The default behaviour is to copy all remaining source content. Type: number
startOffset [optional]	Offset (in milliseconds) relative to the beginning to start the copy operation from. Default value is 0 which means that the copy will start from the beginning of the source content. Type: number