public class

ClipPlayer

org.smartrobot.android.clip.ClipPlayer

Class Overview

로보이드 스튜디오로 만든 클립 파일을 열거나 닫고, 재생 및 중지하는 메소드를 정의한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openResource("org.smartrobot.sample", "sample");
 clipPlayer.play();

 ...

 clipPlayer.stop();
 clipPlayer.close();

Summary

Constants
int ERROR_ILLEGAL_STATE 클립 파일을 열거나 재생, 중지하는 순서가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_CLIP 잘못된 클립임을 나타내는 오류 코드 상수.
int ERROR_INVALID_CONTEXT 컨텍스트가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_FILE 클립 파일이 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_ID 클립 재생기의 ID가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_PACKAGE 패키지 이름이 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_RESOURCE 클립 파일의 리소스 이름이 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_URL 클립 파일의 URL이 잘못 되었음을 나타내는 오류 코드 상수.
Public Methods
static void closeAll()
열려 있는 모든 클립 파일을 닫는다.
static ClipPlayer obtain(clipPlayerId:int)
주어진 ID에 대한 클립 재생기의 인스턴스를 얻는다.
void close()
클립 파일을 닫는다.
int getId()
클립 재생기의 ID를 반환한다.
Boolean openResource(packageName:String, resName:String)
클립 파일을 연다.
Boolean openUrl(url:String)
클립 파일을 연다.
Boolean play()
클립 파일을 재생한다.
void setOnCompletedListener(listener:Function)
클립 파일의 재생이 완료되었을 때 호출되도록 리스너 함수를 설정한다.
void setOnErrorListener(listener:Function)
클립 파일을 열거나 재생, 중지하는 과정에서 오류가 발생했을 때 호출되도록 리스너 함수를 설정한다.
Boolean stop()
클립 파일의 재생을 중지한다.

Constants

public static const ERROR_ILLEGAL_STATE:int

라이브러리 버전 1.0.0부터

클립 파일을 열거나 재생, 중지하는 순서가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -8

public static const ERROR_INVALID_CLIP:int

라이브러리 버전 1.0.0부터

잘못된 클립임을 나타내는 오류 코드 상수.

  • 상수 값: -6

public static const ERROR_INVALID_CONTEXT:int

라이브러리 버전 1.0.0부터

컨텍스트가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -2

public static const ERROR_INVALID_FILE:int

라이브러리 버전 1.0.0부터

클립 파일이 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -7

public static const ERROR_INVALID_ID:int

라이브러리 버전 1.0.0부터

클립 재생기의 ID가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -1

public static const ERROR_INVALID_PACKAGE:int

라이브러리 버전 1.0.0부터

패키지 이름이 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -4

public static const ERROR_INVALID_RESOURCE:int

라이브러리 버전 1.0.0부터

클립 파일의 리소스 이름이 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -5

public static const ERROR_INVALID_URL:int

라이브러리 버전 1.0.0부터

클립 파일의 URL이 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -3

Public Methods

public static function closeAll ():void

라이브러리 버전 1.3.0부터

열려 있는 모든 클립 파일을 닫는다.

클립 파일을 닫은 후에는 play() 혹은 stop() 메소드를 호출하여 클립 파일을 재생하거나 중지할 수 없다. 애플리케이션이 종료되기 전에 반드시 생성된 모든 클립 재생기에 대해 close() 혹은 ClipPlayer.closeAll() 메소드를 호출하여 클립 파일을 닫아야 한다.

public static function obtain (clipPlayerId:int):ClipPlayer

라이브러리 버전 1.3.0부터

주어진 ID에 대한 클립 재생기 객체를 얻는다.

clipPlayerId는 클립 재생기를 구분하기 위해 사용자가 지정하는 ID 값이다. clipPlayerId에 대한 클립 재생기 객체가 이미 존재하는 경우에는 기존의 클립 재생기 객체를 반환하고, 존재하지 않으면 새로 생성하여 반환한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0); // 0번 클립 재생기 객체를 얻는다.
Parameters
clipPlayerId 클립 재생기의 ID
Returns
  • 클립 재생기 객체 또는 null

public function close ():void

라이브러리 버전 1.0.0부터

클립 파일을 닫는다.

클립 파일을 닫은 후에는 play() 혹은 stop() 메소드를 호출하여 클립 파일을 재생하거나 중지할 수 없다. 애플리케이션이 종료되기 전에 반드시 생성된 모든 클립 재생기에 대해 close() 혹은 ClipPlayer.closeAll() 메소드를 호출하여 클립 파일을 닫아야 한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openResource("org.smartrobot.sample", "sample");
 ...
 clipPlayer.close(); // 클립 파일을 닫는다.

public function getId ():int

라이브러리 버전 1.0.0부터

클립 재생기의 ID를 반환한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 var id:int = clipPlayer.getId(); // 클립 재생기의 ID를 얻는다.
Returns
  • 클립 재생기의 ID

public function openResource (packageName:String, resName:String):Boolean

라이브러리 버전 1.0.0부터

클립 파일을 연다.

클립 파일(mcs 파일)은 raw 폴더에 있어야 하며, resName은 클립 파일의 확장자를 제외한 파일 이름이다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openResource("org.smartrobot.sample", "sample"); // 클립 파일을 연다.
Parameters
packageName 클립 파일이 있는 패키지의 이름
resName 클립 파일의 리소스 이름
Returns
  • 성공하면 true, 아니면 false

public function openUrl (url:String):Boolean

라이브러리 버전 1.0.0부터

클립 파일을 연다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openUrl("http://www.sample.org/sample.mcs"); // 클립 파일을 연다.
Parameters
url 클립 파일의 URL
Returns
  • 성공하면 true, 아니면 false

public function play ():Boolean

라이브러리 버전 1.0.0부터

클립 파일을 재생한다.

close() 혹은 ClipPlayer.closeAll() 메소드를 호출하여 클립 파일을 닫은 후에는 클립 파일이 재생되지 않고 false를 반환한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openResource("org.smartrobot.sample", "sample");
 clipPlayer.play(); // 클립 파일을 재생한다.
Returns
  • 성공하면 true, 아니면 false

public function setOnCompletedListener (listener:Function):void

라이브러리 버전 1.3.0부터

클립 파일의 재생이 완료되었을 때 호출되도록 리스너 함수를 설정한다.

리스너 함수는 play() 메소드를 호출하기 전에 설정해야 하며, function onClipCompleted(clipPlayer:ClipPlayer):void의 형태를 가져야 한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.setOnCompletedListener(onClipCompleted);
 clipPlayer.openResource("org.smartrobot.sample", "sample");
 clipPlayer.play();

 function onClipCompleted(clipPlayer:ClipPlayer):void
 {
 }
Parameters
listener 설정할 리스너 함수

public function setOnErrorListener (listener:Function):void

라이브러리 버전 1.3.0부터

클립 파일을 열거나 재생, 중지하는 과정에서 오류가 발생했을 때 호출되도록 리스너 함수를 설정한다.

리스너 함수는 openResource(packageName:String, resName:String) 메소드 또는 openUrl(url:String) 메소드를 호출하기 전에 설정해야 하며, function onClipError(clipPlayer:ClipPlayer, errorCode:int):void의 형태를 가져야 한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.setOnErrorListener(onClipError);
 clipPlayer.openResource("org.smartrobot.sample", "sample");

 function onClipError(clipPlayer:ClipPlayer, errorCode:int):void
 {
 }
Parameters
listener 설정할 리스너 함수

public function stop ():Boolean

라이브러리 버전 1.0.0부터

클립 파일의 재생을 중지한다.

close() 혹은 ClipPlayer.closeAll() 메소드를 호출하여 클립 파일을 닫은 후에는 false를 반환한다.

 var clipPlayer:ClipPlayer = ClipPlayer.obtain(0);
 clipPlayer.openResource("org.smartrobot.sample", "sample");
 clipPlayer.play();
 ...
 clipPlayer.stop(); // 클립 파일의 재생을 중지한다.
Returns
  • 성공하면 true, 아니면 false