Audio - Documentation

Methods

getProjectAudios() → {Array.<XelfAudio>}

Source:

sample.js, line 1826

프로젝트 오디오 배열을 반환함

Example

getProjectAudios()
// [{src: '...', name: '...'}]

Returns:

XelfAudio[] 프로젝트 오디오 배열

Type: Array.<XelfAudio>

volumeProjectAudio(src, volume) → {void}

Source:

sample.js, line 1838

프로젝트 오디오의 볼륨을 조절함

Example

volumeProjectAudio(audioSrc, .5)

Parameters:

Name	Type	Description
`src`	string	대상 audio의 src
`volume`	number	0~1 까지의 수

Returns:

Type: void

stopProjectAudio(src, fadeOutDuration) → {void}

Source:

sample.js, line 1851

프로젝트 오디오의 볼륨을 조절함

Example

stopProjectAudio(audioSrc, 500)

Parameters:

Name	Type	Description
`src`	string	대상 audio의 src
`fadeOutDuration`	number	milisecond

Returns:

Type: void

playProjectAudio(src, options) → {void}

Source:

sample.js, line 1864

가져온 src를 프로젝트 오디오에서 재생시킴

Example

playProjectAudio(audioSrc, {
  loop: false,
  fadeInDuration: 500,
  fadeOutDuration: 500,
})

Parameters:

Name Type Description

src string 대상 audio의 src

options

object

Properties

Name	Type	Attributes	Default	Description
`loop`	boolean	<optional>	`true`	반복재생 여부
`fadeInDuration`	number	<optional>	`0`	페이드인까지의 시간 milisecond로 기입
`fadeOutDuration`	number	<optional>	`0`	페이드아웃까지의 시간 milisecond로 기입

Returns:

Type: void

getPageAudios(pageId) → {Array.<XelfAudio>}

Source:

sample.js, line 1884

해당 페이지에 소속된 오디오 리스트를 가져옴

Example

getPageAudios('pageId')
//

Parameters:

Name	Type	Description
`pageId`	string	audio를 가져올 페이지의 아이디

Returns:

XelfAudio[]

Type: Array.<XelfAudio>

playAudio(src, options) → {void}

Source:

sample.js, line 1897

해당 오디오 src를 페이지에서 재생

Example

playAudio('https://audio.mp3', {
  loop: false,
  fadeInDuration: 500,
  fadeOutDuration: 500,
})
//

Parameters:

Name Type Description

src string 대상 audio의 src

options

object

Properties

Name	Type	Attributes	Default	Description
`loop`	boolean	<optional>	`true`	반복재생 여부
`fadeInDuration`	number	<optional>	`0`	페이드인까지의 시간 milisecond로 기입
`fadeOutDuration`	number	<optional>	`0`	페이드아웃까지의 시간 milisecond로 기입

Returns:

Type: void

volumeAudio(src, volume) → {void}

Source:

sample.js, line 1918

src에 해당하는 페이지 내 오디오의 볼륨을 조절한다

Example

playAudio('https://audio.mp3', 0.3)
//

Parameters:

Name	Type	Description
`src`	string	대상 audio의 src
`volume`	number	0부터 1까지의 수

Returns:

Type: void

stopAudio(src, options) → {void}

Source:

sample.js, line 1932

src에 해당하는 페이지 내 오디오를 멈춘다

Example

stopAudio('https://audio.mp3', {
  loop: false,
  fadeInDuration: 500,
  fadeOutDuration: 500,
})
//

Parameters:

Name Type Description

src string 대상 audio의 src

options

object

Properties

Name	Type	Attributes	Default	Description
`loop`	boolean	<optional>	`true`	반복재생 여부
`fadeInDuration`	number	<optional>	`0`	페이드인까지의 시간 milisecond로 기입
`fadeOutDuration`	number	<optional>	`0`	페이드아웃까지의 시간 milisecond로 기입

Returns:

Type: void

stopAllAudios(fadeOutDurationopt) → {void}

Source:

sample.js, line 1953

재생되고 있는 모든 오디오를 멈춘다

Example

stopAllAudios(500)
//

Parameters:

Name	Type	Attributes	Default	Description
`fadeOutDuration`	number	<optional>	`0`	페이드아웃까지의 시간 milisecond로 기입

Returns:

Type: void

muteAllAudios(fadeOutDurationopt) → {void}

Source:

sample.js, line 1966

재생되고 있는 모든 오디오를 음소거한다

Example

muteAllAudios(500)
//

Parameters:

Name	Type	Attributes	Default	Description
`fadeOutDuration`	number	<optional>	`0`	페이드아웃까지의 시간 milisecond로 기입

Returns:

Type: void

Type Definitions

XelfAudio

Source:

sample.js, line 1816

Properties:

Name	Type	Description
`src`	string	프로젝트의 제목(title)
`name`	string	프로젝트의 저작자(author)

XELF 프로젝트 내 오디오를 생성/삽입/제거 시 사용하는 객체임
사용자가 직접 수정하거나 사용하는 기능은 없음

Type:

Object