●AS3のYouTube Data APIライブラリ:ドキュメント生成
flash(AS3.0)でYouTube Data APIへアクセスする場合、
AS3 YouTube Data API
を使うと便利なのですが、ドキュメント類が整備されていないので、よく分からない、という方もいるかもしれません。
ということで、ドキュメントの作り方をまとめておきます。
--
--
AS3 SDKには、asdocというツールが添付されているので、ドキュメント生成にはこのツールを使います。
例えば、~/dev/flash/lib/google-youtubeにライブラリを展開した場合、 コマンドラインから
$ cd ~/dev/flash/lib/google-youtube $ asdoc -source-path . -doc-sources ./ca/newcommerce/youtube/data/ -doc-sources ./ca/newcommerce/youtube/webservice/ -doc-sources ./ca/newcommerce/youtube/feeds/ -doc-sources ./ca/newcommerce/youtube/events/
という感じでコマンド入力すれば、cdしたディレクトリ以下にasdoc-outputというディレクトリが生成され、その中のindex.htmlを見ればpublicのメソッドとプロパティがリストされるので、ソースを直読みするよりもちょっとだけ見やすくなります。
基本的には、package { import ca.newcommerce.youtube.data.*; import ca.newcommerce.youtube.events.*; import ca.newcommerce.youtube.feeds.*; import ca.newcommerce.youtube.iterators.*; import ca.newcommerce.youtube.webservice.YouTubeClient; public class ytTest { protected var _ws:YouTubeClient; protected var _requestId:Number; public function ytTest() { _ws = YouTubeClient.getInstance(); _ws.addEventListener(VideoFeedEvent.VIDEO_DATA_RECEIVED, doSearchResults); _requestId = _ws.getVideos("Sims2", "", null, null, null, null, YouTubeClient.ORDER_BY_VIEWCOUNT,"exclude",1,3); } protected function doSearchResults(evt:VideoFeedEvent):void { if(_requestId == evt.requestId) { var feed:VideoFeed = evt.feed; var video:VideoData; while(video = feed.next()) { // video.title // video.actualId var tnIt:ThumbnailIterator = video.media.thumbnails; var tn:ThumbnailData; while(tn = tnIt.next()) { // tn.url } } } } } }こんな感じで使います。
この例では、getVideosメソッドにSims2というキーワードを与えて閲覧回数の多い順に3件のデータを取得後、ビデオID、タイトル、サムネイルを取得するサンプルとなっています。
メソッドは、生成されたドキュメントの
Class YouTubeClientを見れば分かります。
ここで使ったgetVideo以外にもgetStandardFeedを使ってよく見られているフィードを取得することも出来るようになっているので、用途に応じて使い分ければよいでしょう。
サンプルの中で使っているデータ取得に関しては、
Class VideoDataを見ればpublicプロパティがリストされています。
ビデオIDは、idではなくてactualIdってところが注意点でしょうか。
ちなみに、AS3用のYoutube APIには、 AS3 YouTube API というライブラリがありますが、こちらはgoogleに吸収される前にYouTubeがやっていたレガシーAPI専用のライブラリです。 なので、APIキーもYouTubeで発行してもらう必要がありますし、google data apiで実装されているコメント書き込みなどのAPIは利用できません。
今から始める方は、
AS3 YouTube Data API
を使ったほうがよいと思います。
--
Comments
コメント入力は停止しています
海外からと思われるコメントスパムが横行しているため、全記事のコメント入力を停止しています。メッセージのある方は、ホームページの一番下に連絡欄がありますので、そちらからお願いします。