Foxit PDF SDK

构造函数 | 所有成员列表
FSSound类 参考
类 FSSound 继承关系图:

## 构造函数
(int) | - getBits
| 获取每个通道每个采样值的位数。 更多...
(int) | - getChannelCount
| 获取声音通道数。 更多...
(NSString *) | - getCompressionFormat
| 获取用于采样数据的声音压缩格式的名称。 更多...
(FSFileSpec *) | - getFileSpec
| 获取表示外部声音文件的文件规范对象。 更多...
(FSSoundSampleEncodingFormat) | - getSampleEncodingFormat
| 获取采样数据的编码格式。 更多...
(float) | - getSamplingRate
| 获取采样率，以每秒采样数为单位。 更多...
(FSPDFStream *) | - getSoundStream
| 获取声音数据的流。 更多...
(id) | - init
| 构造函数。
(id) | - initWithAnnot:
| 构造函数，使用父类对象。 更多...
构造函数 继承自 FSMarkup
(FSNote *) | - addReply
| 在回复列表的末尾添加新回复。 更多...
(void) | - addRichText:style:
| 在末尾添加新的富文本字符串。 更多...
(FSNote *) | - addStateAnnot:model:state:
| 添加新的状态注释。 更多...
(FSMarkupArray *) | - getGroupElements
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
(FSMarkup *) | - getGroupHeader
| 获取当前标记注释所属组的头注释（作为主注释）。 更多...
(FSNote *) | - getReply:
| 按索引获取回复。 更多...
(int) | - getReplyCount
| 计算所有回复。 更多...
(NSString *) | - getRichTextContent:
| 获取指定索引的富文本字符串的文本字符串。 更多...
(int) | - getRichTextCount
| 获取富文本字符串的数量。 更多...
(FSRichTextStyle *) | - getRichTextStyle:
| 获取指定索引的富文本字符串的样式数据。 更多...
(FSNoteArray *) | - getStateAnnots:
| 获取指定状态模型中的所有状态注释。 更多...
(void) | - insertRichText:content:style:
| 在指定索引位置插入新的富文本字符串。 更多...
(BOOL) | - isGrouped
| 检查当前标记注释是否在组中。 更多...
(BOOL) | - removeAllReplies
| 删除所有回复。 更多...
(BOOL) | - removeAllStateAnnots
| 移除所有状态注释。 更多...
(BOOL) | - removePopup
| 删除相关的弹出注释。 更多...
(BOOL) | - removeReply:
| 按索引删除回复。 更多...
(void) | - removeRichText:
| 移除指定索引的富文本字符串。 更多...
(void) | - setRichTextContent:content:
| 设置指定索引的富文本字符串的文本字符串。 更多...
(void) | - setRichTextStyle:style:
| 设置指定索引的富文本字符串的样式数据。 更多...
(BOOL) | - ungroup
| 将当前标记注释从其所属的组中解组。 更多...
构造函数 继承自 FSAnnot
(BOOL) | - FSMoveWithResetAppearance:is_reset_appearance:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - FSResetApStreamWithIsGenerateNewAppearanceObj:
| 重置外观流。 更多...
(FSPDFStream *) | - getAppearanceStream:appearance_state:
| 获取具有指定类型和状态的注释外观流。 更多...
(FSRectI *) | - getDeviceRect:
| 获取设备坐标系统中的注释矩形。 更多...
(FSPDFDictionary *) | - getDict
| 获取注释的字典对象。 更多...
(FSMatrix2D *) | - getDisplayMatrix:
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
(int) | - getIndex
| 获取当前注释在其所属页面中的索引。 更多...
(FSPDFDictionary *) | - getOptionalContent
| 获取注释可选内容的PDF字典。 更多...
(FSPDFPage *) | - getPage
| 获取相关的PDF页面。 更多...
(FSRectF *) | - getRect
| 获取矩形，以表示。 更多...
(FSAnnotType) | - getType
| 获取当前注释的实际注释类型。 更多...
(BOOL) | - hasProperty:
| 当前注释是否具有指定的注释属性。 更多...
(id) | - initWithPage:annot_dict:
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isMarkup
| 检查当前注释是否为标记注释。 更多...
(BOOL) | - move:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - removeProperty:
| 删除指定的注释属性。 更多...
(BOOL) | - resetAppearanceStream
| 重置外观流。 更多...

## 额外继承的成员函数
属性 继承自 FSMarkup
float | borderOpacity
| 获取注释的边框透明度。
FSDateTime * | creationDateTime
| 获取创建日期时间。
float | fillOpacity
| 获取注释的填充透明度。
NSString * | intent
| 获取意图名称。 更多...
float | opacity
| 获取不透明度值。 更多...
FSPopup * | popup
| 获取相关的弹出注释。 更多...
NSString * | subject
| 获取主题字符串。
NSString * | title
| 获取标题字符串。 更多...
属性 继承自 FSAnnot
unsigned int | borderColor
| 获取边框颜色。 更多...
FSBorderInfo * | borderInfo
| 获取边框信息。 更多...
NSString * | content
| 获取内容。
unsigned int | flags
| 获取注释标志。
FSDateTime * | modifiedDateTime
| 获取最后修改日期时间。
NSString * | uniqueID
| 获取唯一ID。

## 详细描述

声音注释（PDF 1.2）类似于文本注释，不同之处在于它包含从计算机麦克风录制的声音 或从文件导入的声音，而不是文本注释。 声音注释是一种标记注释，所以类FSSound 派生自 类FSMarkup 。目前，仅支持获取声音注释的属性或数据。 尚不支持修改声音注释（包括重置外观）。

参见
  FSMarkup

## 函数文档

## ◆ getBits()

- (int) getBits |  |  |

获取每个通道每个采样值的位数。

返回
  每个通道每个采样值的位数。

## ◆ getChannelCount()

- (int) getChannelCount |  |  |

获取声音通道数。

返回
  声音通道数。

## ◆ getCompressionFormat()

- (NSString *) getCompressionFormat |  |  |

获取用于采样数据的声音压缩格式的名称。

返回
  用于采样数据的声音压缩格式的名称。

## ◆ getFileSpec()

- (FSFileSpec *) getFileSpec |  |  |

获取表示外部声音文件的文件规范对象。

声音可能在外部文件中定义（由文件规范对象表示）。 声音文件应该是自描述的，包含渲染声音所需的所有信息； PDF文件中不需要额外的信息。
在这种情况下，应忽略返回的流对象。

返回
  表示外部声音文件的文件规范对象。如果返回的文件规范对象的 函数FSFileSpec::isEmpty的返回值为YES， 则表示当前声音注释没有使用外部声音文件。 在这种情况下，请使用函数FSSound::getSoundStream获取声音数据。

## ◆ getSampleEncodingFormat()

- (FSSoundSampleEncodingFormat) getSampleEncodingFormat |  |  |

获取采样数据的编码格式。

返回
  采样数据的编码格式。请参考从 FSSoundSampleEncodingFormatRaw开始的值，这将是这些值中的一个。

## ◆ getSamplingRate()

- (float) getSamplingRate |  |  |

获取采样率，以每秒采样数为单位。

返回
  采样率。如果有任何错误，此函数将返回-1。

## ◆ getSoundStream()

- (FSPDFStream *) getSoundStream |  |  |

获取声音数据的流。

声音数据的流表示声音，可用于在注释被激活时播放。
特别地，如果函数FSSound::getFileSpec返回有效的文件规范对象 （其FSFileSpec::isEmpty返回NO），请使用该文件规范对象 而不是此函数返回的流。

返回
  声音数据的流。如果没有"Sound"条目或发生任何错误，此函数将返回nil。

## ◆ initWithAnnot:()

- (id) initWithAnnot: |  | (FSAnnot*) | annot |

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

重载 FSMarkup .