xr-frame / Exports / ShareSystem

# Class: ShareSystem

分享系统，负责分享相关功能。

# Hierarchy

• Component<IShareSystemData>

  ↳ ShareSystem

# Table of contents

# Constructors

• constructor

# Events

• onAdd
• onRelease
• onRemove
• onTick
• onUpdate

# Properties

• priority
• schema
• EVENTS

# Accessors

• el
• recordState
• scene
• supported
• version

# Methods

• captureToArrayBuffer
• captureToArrayBufferAsync
• captureToDataURL
• captureToDataURLAsync
• captureToFriends
• captureToLocalPath
• getData
• recordFinishToAlbum
• recordFinishToTempFile
• recordPause
• recordResume
• recordStart
• setData
• setDataOne

# Constructors

# constructor

• new ShareSystem()

# Inherited from

Component.constructor

# Events

# onAdd

▸ onAdd(parent, data): void

所挂载的element被挂载到场景时触发的回调。

# Parameters

# Returns

void

# Inherited from

Component.onAdd

---

# onRelease

▸ onRelease(data): void

从被挂载的element上被移除，或是element被销毁时，触发的回调。 一般用于释放持有的资源。

# Parameters

# Returns

void

# Inherited from

Component.onRelease

---

# onRemove

▸ onRemove(parent, data): void

所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。 一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

# Parameters

# Returns

void

# Inherited from

Component.onRemove

---

# onTick

▸ onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

# Returns

void

# Inherited from

Component.onTick

---

# onUpdate

▸ onUpdate(data, preData): void

数据更新时触发的回调。

# Parameters

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# priority

• Readonly priority: number

自定义组件的更新优先级。

# Overrides

Component.priority

---

# schema

• Readonly schema: IComponentSchema = {}

自定义组件的schema。

# Inherited from

Component.schema

---

# EVENTS

▪ Static EVENTS: string[] = []

# Inherited from

Component.EVENTS

# Accessors

# el

• get el(): Element

挂载的元素。

# Returns

Element

---

# recordState

• get recordState(): EShareRecordState

当前录屏状态。

# Returns

EShareRecordState

---

# scene

• get scene(): Scene

当前场景。

# Returns

Scene

---

# supported

• get supported(): boolean

当前是否支持分享系统。

# Returns

boolean

---

# version

• get version(): number

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

# Returns

number

# Methods

# captureToArrayBuffer

▸ captureToArrayBuffer(options?): ArrayBuffer

deprecated 请在v3.0.2后使用异步版本，同步版本不再维护，请使用captureToArrayBufferAsync。 截屏输出为ArrayBuffer。

# Parameters

# Returns

ArrayBuffer

---

# captureToArrayBufferAsync

▸ captureToArrayBufferAsync(options?): Promise<ArrayBuffer>

截屏输出为ArrayBuffer。

# Parameters

# Returns

Promise<ArrayBuffer>

---

# captureToDataURL

▸ captureToDataURL(options?): string

deprecated 请在v3.0.2后使用异步版本，同步版本不再维护，请使用captureToDataURLAsync。 截屏输出为base64。

# Parameters

# Returns

string

---

# captureToDataURLAsync

▸ captureToDataURLAsync(options?): Promise<string>

截屏输出为base64。

# Parameters

# Returns

Promise<string>

---

# captureToFriends

▸ captureToFriends(options?): Promise<void>

直接截屏分享给好友。

# Parameters

# Returns

Promise<void>

---

# captureToLocalPath

▸ captureToLocalPath(options?, callback): Promise<void>

截屏输出为本地路径，回调完成后会自动释放。

params callback 接受结果的回调，处理完后会释放文件。在v2.27.1前是异步，之后兼容同步和异步。

# Parameters

# Returns

Promise<void>

---

# getData

▸ getData<T>(key): IShareSystemData[T]

获取一个当前值。

# Type parameters

# Parameters

# Returns

IShareSystemData[T]

# Inherited from

Component.getData

---

# recordFinishToAlbum

▸ recordFinishToAlbum(): Promise<void>

录屏完成，直接保存到用户相册。

# Returns

Promise<void>

---

# recordFinishToTempFile

▸ recordFinishToTempFile(): Promise<string>

录屏完成，输出到临时文件。

# Returns

Promise<string>

临时文件地址

---

# recordPause

▸ recordPause(): Promise<void>

暂停本次录屏。

# Returns

Promise<void>

---

# recordResume

▸ recordResume(): Promise<void>

唤醒本次录屏。

# Returns

Promise<void>

---

# recordStart

▸ recordStart(options?): Promise<void>

启动录屏。

# Parameters

# Returns

Promise<void>

---

# setData

▸ setData(data): void

不通过xml而是直接设置data，注意值的类型需要和schema中一致。

# Parameters

# Returns

void

# Inherited from

Component.setData

---

# setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

# Parameters

# Returns

void

# Inherited from

Component.setDataOne