Class google.gdata.mediarss.MediaText

Object
   |
   +--google.gdata.mediarss.MediaText

class google.gdata.mediarss.MediaText

Describes a media text.
Defined in gdata.js

Field Detail

$t

{string|undefined} $t

Text transcript, closed captioning, or lyrics. This attribute is optional.

end

{string|undefined} end

End time that the text is relevant. This attribute is optional.

lang

{string|undefined} lang

Primary language in the object. This attribute is optional.

start

{string|undefined} start

Start time offset when the text starts. This attribute is optional.

type

{string|undefined} type

Type of text embedded, either plain or html. This attribute is optional.

TYPE_HTML

<static> <final> {string} TYPE_HTML

Entity encoded html.

See Also:

Constant Field Values

TYPE_PLAIN

<static> <final> {string} TYPE_PLAIN

Plain text.

See Also:

Constant Field Values

google.gdata.mediarss.MediaText

google.gdata.mediarss.MediaText(<Object> opt_params)

Constructs a media text using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: content, end, lang, start, and type.

getContent

string|undefined getContent()

Returns the text transcript, closed captioning, or lyrics. This attribute is optional.

Returns:
Text transcript, closed captioning, or lyrics or undefined for none.

getEnd

string|undefined getEnd()

Returns the end time that the text is relevant. This attribute is optional.

Returns:
End time that the text is relevant or undefined for none.

getLang

string|undefined getLang()

Returns the primary language in the object. This attribute is optional.

Returns:
Primary language in the object or undefined for none.

getStart

string|undefined getStart()

Returns the start time offset when the text starts. This attribute is optional.

Returns:
Start time offset when the text starts or undefined for none.

getType

string|undefined getType()

Returns the type of text embedded, either plain or html. This attribute is optional.

Returns:
Type of text embedded, either plain or html or undefined for none.

setContent

void setContent(<string|undefined> content)

Sets the text transcript, closed captioning, or lyrics. This attribute is optional.

Parameters:
content - Text transcript, closed captioning, or lyrics or undefined for none.

setEnd

void setEnd(<string|undefined> end)

Sets the end time that the text is relevant. This attribute is optional.

Parameters:
end - End time that the text is relevant or undefined for none.

setLang

void setLang(<string|undefined> lang)

Sets the primary language in the object. This attribute is optional.

Parameters:
lang - Primary language in the object or undefined for none.

setStart

void setStart(<string|undefined> start)

Sets the start time offset when the text starts. This attribute is optional.

Parameters:
start - Start time offset when the text starts or undefined for none.

setType

void setType(<string|undefined> type)

Sets the type of text embedded, either plain or html. This attribute is optional.

Parameters:
type - Type of text embedded, either plain or html or undefined for none.