ヘルプ

Craving Explorer Site Script 仕様

動画ダウンロードに対応するサイトを追加する為のAPI、 Script 仕様です。

API利用方法: site-script フォルダにスクリプトを追加すると自動で認識されます。現在対応しているのものは Javascript(拡張子.site.js) のみになります。

動画ダウンロードに対応しているページを表示すると、ツールバーの『動画のダウンロード』ボタンが有効になります。
インストール方法についてはこちら、管理方法についてはこちらをご覧ください。

API 仕様

isSiteUrl( String url )

概要
ページの表示が完了すると呼び出されます。スクリプトで対応している URL の場合、true を返してください。
引数

String url Craving Explorer で表示中の URL
戻り値

Bool 対応している URL : true / 対応していない URL : false

String url	Craving Explorer で表示中の URL

Bool	対応している URL : true / 対応していない URL : false

getVideoDetail( String url )

概要
保存ボタン等から保存しようとしたときに呼び出されます。URL で指定されたページの動画タイトル、URL、追加する Http Header を返してください。一度に複数の動画を返すことができます。
引数

String url Craving Explorer で表示中の URL

String url	Craving Explorer で表示中の URL

戻り値

動画タイトル	videoTitle[0,1,2 ... n]: "タイトル" - （必須）
動画 URL	videoUrl[0,1,2 ... n]: "URL" - （必須）
追加 HTTP Header	httpHeader[0,1,2 ... n]: "追加のHTTPHeader" - （省略可能）

ex.)

return {
    videoTitle0:"タイトルその１", videoUrl0:"http://hoge/hoge0.flv", httpHeader0:"UserAgent: hoge"
  , videoTitle1:"タイトルその２", videoUrl1:"http://hoge/hoge1.flv", httpHeader1:"UserAgent: hoge"
};

メタデータ仕様

Site Script の先頭行から、『// ==SiteScript==』で始まり、『// ==/SiteScript==』で終わるコメントを置くことで、メタデータを記載することができます。Craving Explorer はこのメタデータを元に、Site Script を管理します。

@siteName
対応するサイトの名前です。
@siteUrl
対応するサイトの URL です。
@author
Site Script 作者名です。
@authorUrl
Site Script 作者の URL です。
@scriptUrl
Site Script のある URL です。URL + Site Script のファイル名の場所をチェックして更新の確認を行います。
@version
Site Script バージョン情報です。最長 4 つの Dot(.) 区切り数値で表されます。このバージョンが大きいと Site Script が更新されているとみなされます。

ex.)

// ==SiteScript==
// @siteNameDailymotion{
// @siteUrlhttp://www.dailymotion.com/jp
// @author tuck
// @authorUrlhttp://www.crav-ing.com/
// @scriptUrlhttp://archive.crav-ing.com/site-script/
// @version1.0.0.0
// ==/SiteScript==

Site Script の公開方法

Site Script の仕様に従ったファイルを『.site.js』の拡張子で HTTP サーバーにアップしてください。Craving Explorer では『.site.js』の拡張子をもつファイルにアクセスすると、メタデータが正当かどうかを解析し、正当であればインストールダイアログを表示します。

Site Script を作成、公開された際には、是非作者までご連絡下さい。Craving Explorer サイト上でリンクさせて頂きます。