Public Member Functions | Public Attributes | List of all members
sbITranscodeError Interface Reference

import"sbITranscodeError.idl";

Inheritance diagram for sbITranscodeError:
[legend]
Collaboration diagram for sbITranscodeError:
[legend]

Public Member Functions

void init (in AString aMessageWithItem, in AString aMessageWithoutItem, in AString aDetails)
 

Public Attributes

readonly attribute AString messageWithItem
 
readonly attribute AString messageWithoutItem
 
readonly attribute AString detail
 
attribute AString sourceUri
 
attribute sbIMediaItem sourceItem
 
attribute AString destUri
 
attribute sbIMediaItem destItem
 

Detailed Description

Definition at line 31 of file sbITranscodeError.idl.

Member Function Documentation

void sbITranscodeError::init ( in AString  aMessageWithItem,
in AString  aMessageWithoutItem,
in AString  aDetails 
)

Initialize the transcode error

Member Data Documentation

attribute sbIMediaItem sbITranscodeError::destItem

The media item of the transcoding destination, if available. May be null.

Definition at line 71 of file sbITranscodeError.idl.

attribute AString sbITranscodeError::destUri

The URI of the transcoding destination file, if available. May not be null.

Definition at line 66 of file sbITranscodeError.idl.

readonly attribute AString sbITranscodeError::detail

A longer detailed message. This may be more technical and used for debugging purposes. This will not be localized.

Definition at line 51 of file sbITranscodeError.idl.

readonly attribute AString sbITranscodeError::messageWithItem

The string key in songbird.properties for the error message, for when the media item is available. If the localized string contains the substring "%(item)", that substring will be replaced with the title of the media item.

Definition at line 37 of file sbITranscodeError.idl.

readonly attribute AString sbITranscodeError::messageWithoutItem

The string key in songbird.properties for the error message, for when the media item is not available. If the localized string contains the substring "%(item)", that substring will be replaced with the url of the media item.

Definition at line 45 of file sbITranscodeError.idl.

attribute sbIMediaItem sbITranscodeError::sourceItem

The media item of the transcoding source, if available. May be null.

Definition at line 61 of file sbITranscodeError.idl.

attribute AString sbITranscodeError::sourceUri

The URI of the transcoding source file, if available. May be null.

Definition at line 56 of file sbITranscodeError.idl.

The documentation for this interface was generated from the following file: