fsdk.RenditionAction类 参考

Public 成员函数
def	GetJavaScript ()
	获取要执行的JavaScript脚本。 更多...
def	GetOperationType ()
	获取当前再现动作在被触发时的操作类型。 更多...
def	GetRendition (index)
	通过索引获取再现。 更多...
def	GetRenditionCount ()
	获取再现对象的数量。 更多...
def	GetScreenAnnot ()
	获取相关的屏幕注释。 更多...
def	InsertRendition (rendition, index)
	在索引指定的位置将再现插入到当前再现动作中。 更多...
def	RemoveRendition (rendition)
	从当前再现动作中移除再现对象。 更多...
def	SetJavaScript (script)
	设置要执行的JavaScript脚本。 更多...
def	SetOperationType (op_type)
	设置当前再现动作在被触发时的操作类型。 更多...
def	SetScreenAnnot (screen_annot)
	设置相关的屏幕注释。 更多...

详细描述

再现动作是控制多媒体内容的播放。(更多详情，请参考 <PDF参考1.7> P668 "再现动作") 类fsdk.RenditionAction 派生自Action ，提供用于 获取/设置再现动作数据的函数。

参见

Action

成员函数说明

GetJavaScript()

def fsdk.RenditionAction.GetJavaScript

(

)

获取要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回

JavaScript脚本。

GetOperationType()

def fsdk.RenditionAction.GetOperationType

(

)

获取当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回

操作类型。请参考fsdk.RenditionActionE_OpTypeNone 开始的值， 这将是这些值中的一个。

GetRendition()

def fsdk.RenditionAction.GetRendition

(

index

)

通过索引获取再现。

参数

[in]

index

要检索的再现对象的索引。有效范围：从0到(count-1)。 count由函数fsdk.RenditionAction.GetRenditionCount 返回。

返回

再现对象。

GetRenditionCount()

def fsdk.RenditionAction.GetRenditionCount

(

)

获取再现对象的数量。

返回

再现对象的数量。

GetScreenAnnot()

def fsdk.RenditionAction.GetScreenAnnot

(

)

获取相关的屏幕注释。

返回

屏幕注释对象。

InsertRendition()

def fsdk.RenditionAction.InsertRendition	(		rendition,
			index
	)

在索引指定的位置将再现插入到当前再现动作中。

当操作类型为fsdk.RenditionActionE_OpTypeAssociate 或 fsdk.RenditionActionE_OpTypeAssociate 时，再现对象对于再现动作是必需的。

参数

[in]	rendition	要插入的再现对象。
[in]	index	指定插入再现对象位置的索引。 如果索引小于0或大于(count-1)，输入的再现将被 插入到末尾。count由函数 fsdk.RenditionAction.GetRenditionCount 返回。

返回

无。

RemoveRendition()

def fsdk.RenditionAction.RemoveRendition

(

rendition

)

从当前再现动作中移除再现对象。

参数

[in]

rendition

要从当前再现动作中移除的再现对象。

返回

无。

SetJavaScript()

def fsdk.RenditionAction.SetJavaScript

(

script

)

设置要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

[in]

script

要设置的JavaScript脚本。

返回

无。

SetOperationType()

def fsdk.RenditionAction.SetOperationType

(

op_type

)

设置当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

[in]

op_type

操作类型。请参考fsdk.RenditionActionE_OpTypeAssociate 开始的值， 这应该是这些值中的一个。如果设置值fsdk.RenditionActionE_OpTypeNone ， 那意味着没有指定操作类型。

返回

无。

SetScreenAnnot()

def fsdk.RenditionAction.SetScreenAnnot

(

screen_annot

)

设置相关的屏幕注释。

当操作类型设置为有效值时，此属性是必需的。

参数

[in]

screen_annot

要设置为相关屏幕注释的屏幕注释对象。

返回

无。