ImagesService(Google App Engine API for Java)

com.google.appengine.api.images

インターフェース ImagesService



  • public interface ImagesService
    画像サービスは、画像に変換を適用するメソッドを提供します。
    • フィールドの詳細

      • SERVING_SIZES

        @Deprecated
        static final java.util.Set<java.lang.Integer> SERVING_SIZES
        サポート終了。 
      • SERVING_CROP_SIZES

        @Deprecated
        static final java.util.Set<java.lang.Integer> SERVING_CROP_SIZES
        サポート終了。 
    • メソッドの詳細

      • applyTransform

        Image applyTransform(Transform transform,
                             Image image)
        指定された transform を指定された image に適用し、PNG ファイル形式を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        戻り値:
        変換後の画像
        スロー:
        java.lang.IllegalArgumentException - transform または image が無効な場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image)
        指定された transform を指定された image に非同期的に適用し、PNG ファイル形式を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        戻り値:
        変換後の画像が格納されている future、または applyTransform(Transform, Image) のドキュメントに記載されている例外の 1 つ。
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             ImagesService.OutputEncoding encoding)
        指定された transform を指定された image に適用し、encoding ファイル形式を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        encoding - 使用する出力エンコード
        戻り値:
        変換後の画像
        スロー:
        java.lang.IllegalArgumentException - transformimage、または encoding が無効な場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               ImagesService.OutputEncoding encoding)
        指定された transform を指定された image に非同期的に適用し、encoding ファイル形式を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        encoding - 使用する出力エンコード
        戻り値:
        変換後の画像が格納されている future、または applyTransform(Transform, Image, OutputEncoding) のドキュメントに記載されている例外の 1 つ。
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             OutputSettings settings)
        指定された transform を指定された image に適用し、settings を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        settings - 使用する出力設定
        戻り値:
        変換後の画像
        スロー:
        java.lang.IllegalArgumentException - transformimage、または settings が無効な場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               OutputSettings settings)
        指定された transform を指定された image に非同期的に適用し、settings を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        settings - 使用する出力設定
        戻り値:
        変換後の画像が格納されている future、または applyTransform(Transform, Image, OutputSettings) のドキュメントに記載されている例外の 1 つ。
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             InputSettings inputSettings,
                             OutputSettings outputSettings)
        指定された transform を指定された image に適用し、inputSettings に従って image を解釈する outputSettings を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        inputSettings - 使用する入力設定
        outputSettings - 使用する出力設定
        戻り値:
        変換後の画像
        スロー:
        java.lang.IllegalArgumentException - transformimageinputSettings、または outputSettings が無効な場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               InputSettings inputSettings,
                                                               OutputSettings outputSettings)
        指定された transform を指定された image に非同期的に適用し、inputSettings に従って image を解釈する settings を使用して保存された変換後の画像をエンコードします。変換は、指定された画像に対して適用されます。
        パラメータ:
        transform - 適用する変換
        image - 変換する画像
        inputSettings - 使用する入力設定
        outputSettings - 使用する出力設定
        戻り値:
        変換後の画像が格納されている future、または applyTransform(Transform, Image, InputSettings, OutputSettings) のドキュメントに記載されている例外の 1 つ。
      • composite

        Image composite(java.util.Collection<Composite> composites,
                        int width,
                        int height,
                        long color)
        widthheight で決定されるディメンションと背景色 color を持つキャンバスを使用して、Composite の指定された Collection を適用します。出力エンコードとして PNG を使用します。
        パラメータ:
        composites - 適用する構成オペレーション。
        width - キャンバスの幅(ピクセル単位)。
        height - キャンバスの高さ(ピクセル単位)。
        color - キャンバスの背景色(ARGB 形式)。
        戻り値:
        構成の結果が含まれる新しい画像。
        スロー:
        java.lang.IllegalArgumentException - width または height4,000 より大きい、色が [0, 0xffffffff] の範囲外、composites に含まれている要素が 16 より多い、または composites のコンテンツに問題がある場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • composite

        Image composite(java.util.Collection<Composite> composites,
                        int width,
                        int height,
                        long color,
                        ImagesService.OutputEncoding encoding)
        widthheight で決定されるディメンションと背景色 color を持つキャンバスを使用して、Composite の指定された Collection を適用します。
        パラメータ:
        composites - 適用する構成オペレーション。
        width - キャンバスの幅(ピクセル単位)。
        height - キャンバスの高さ(ピクセル単位)。
        color - キャンバスの背景色(ARGB 形式)。
        encoding - 結果の画像に使用するエンコード。
        戻り値:
        構成の結果が含まれる新しい画像。
        スロー:
        java.lang.IllegalArgumentException - width または height4,000 より大きい、色が [0, 0xffffffff] の範囲外、composites に含まれている要素が 16 より多い、または composites のコンテンツに問題がある場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • composite

        Image composite(java.util.Collection<Composite> composites,
                        int width,
                        int height,
                        long color,
                        OutputSettings settings)
        widthheight で決定されるディメンションと背景色 color を持つキャンバスを使用して、Composite の指定された Collection を適用します。
        パラメータ:
        composites - 適用する構成オペレーション。
        width - キャンバスの幅(ピクセル単位)。
        height - キャンバスの高さ(ピクセル単位)。
        color - キャンバスの背景色(ARGB 形式)。
        settings - 結果の画像に使用する OutputSettings。
        戻り値:
        構成の結果が含まれる新しい画像。
        スロー:
        java.lang.IllegalArgumentException - width または height4,000 より大きい、色が [0, 0xffffffff] の範囲外、composites に含まれている要素が 16 より多い、または composites のコンテンツに問題がある場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • histogram

        int[][] histogram(Image image)
        画像のヒストグラムを計算します。
        パラメータ:
        image - ヒストグラムを計算する画像。
        戻り値:
        長さ 256 の配列 3 個からなる配列。各配列に 1 つのカラーチャネルの画像ヒストグラムが含まれます。チャネルは、エントリ 0 から 3 までの順序付けされた RGB です。各チャネルの範囲は、色が存在しない 0 から色が完全に明るい 255 までです。
      • getServingUrl

        @Deprecated
        java.lang.String getServingUrl(BlobKey blobKey)
        サポート終了。 getServingUrl(ServingUrlOptions) に置き換えられました。
        blob として保存されている画像を動的に提供できる URL を取得します。

        この URL は、世界中で利用できる高パフォーマンスの動的画像配信インフラストラクチャによって提供されます。このメソッドで返される URL は、常に公開 URL ですが、類推可能なものではありません。非公開の URL は現在サポートされていません。URL の提供を停止する場合は、その基本となる blob キーを削除します。これが反映されるまで、最長で 24 時間かかります。この URL 形式では、サイズ変更と切り抜きを動的に実行することもできますが、一定の制限があります。サイズ変更と切り抜きを動的に実行するには、この呼び出しで取得される URL の末尾にオプションを付加します。次に例を示します。getServingUrl -> "http://lh3.ggpht.com/SomeCharactersGoesHere"

        32 ピクセルのサイズ変更バージョン(アスペクト比を保持)を取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32" のように「=s32」を URL に追加します。

        32 ピクセルの切り抜きバージョンを取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32-c" のように「=s32-c」を付加します。

        有効なサイズは、[0, 1600] の範囲の整数で、SERVING_SIZES_LIMIT として利用できます。

        パラメータ:
        blobKey - 返された URL で提供する画像の blob キー。
        戻り値:
        画像を動的に提供できる URL。
        スロー:
        java.lang.IllegalArgumentException - blob キーが有効でないか、画像が含まれていない場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • getServingUrl

        @Deprecated
        java.lang.String getServingUrl(BlobKey blobKey,
                                                   boolean secureUrl)
        サポート終了。 getServingUrl(ServingUrlOptions) に置き換えられました。
        blob として保存されている画像を動的に提供できる URL を取得します。

        この URL は、世界中で利用できる高パフォーマンスの動的画像配信インフラストラクチャによって提供されます。このメソッドで返される URL は、常に公開 URL ですが、類推可能なものではありません。非公開の URL は現在サポートされていません。URL の提供を停止する場合は、その基本となる blob キーを削除します。これが反映されるまで、最長で 24 時間かかります。この URL 形式では、サイズ変更と切り抜きを動的に実行することもできますが、一定の制限があります。サイズ変更と切り抜きを動的に実行するには、この呼び出しで取得される URL の末尾にオプションを付加します。次に例を示します。getServingUrl -> "http://lh3.ggpht.com/SomeCharactersGoesHere"

        32 ピクセルのサイズ変更バージョン(アスペクト比を保持)を取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32" のように「=s32」を URL に追加します。

        32 ピクセルの切り抜きバージョンを取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32-c" のように「=s32-c」を付加します。

        有効なサイズは、[0, 1600] の範囲の整数で、SERVING_SIZES_LIMIT として利用できます。

        パラメータ:
        blobKey - 返された URL で提供する画像の blob キー。
        secureUrl - URL スキームを https にするか http にするかを制御します。
        戻り値:
        画像を動的に提供できる URL。
        スロー:
        java.lang.IllegalArgumentException - blob キーが有効でないか、画像が含まれていない場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • getServingUrl

        @Deprecated
        java.lang.String getServingUrl(BlobKey blobKey,
                                                   int imageSize,
                                                   boolean crop)
        サポート終了。 getServingUrl(ServingUrlOptions) に置き換えられました。
        getServingUrl(BlobKey) によって返された汎用 URL から特定のサイズおよび切り抜きパラメータの提供 URL を計算します。
        パラメータ:
        blobKey - 指定されたサイズと切り抜きを使用して、返された URL で提供する画像の blob キー。
        imageSize - 提供された画像のサイズ(ピクセル単位)。
        crop - 画像をサイズ変更するか切り抜くかを制御します。
        戻り値:
        画像を動的に提供できる URL。
        スロー:
        java.lang.IllegalArgumentException - blob キーが有効でないか、画像が含まれていないか、または指定されたサイズがサービスでサポートされていない場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
        関連情報:
        getServingUrl(BlobKey)
      • getServingUrl

        @Deprecated
        java.lang.String getServingUrl(BlobKey blobKey,
                                                   int imageSize,
                                                   boolean crop,
                                                   boolean secureUrl)
        サポート終了。 getServingUrl(ServingUrlOptions) に置き換えられました。
        getServingUrl(BlobKey) によって返された汎用 URL から特定のサイズおよび切り抜きパラメータの提供 URL を計算します。
        パラメータ:
        blobKey - 指定されたサイズと切り抜きを使用して、返された URL で提供する画像の blob キー。
        imageSize - 提供された画像のサイズ(ピクセル単位)。
        crop - 画像をサイズ変更するか切り抜くかを制御します。
        secureUrl - URL スキームを https にするか http にするかを制御します。
        戻り値:
        画像を動的に提供できる URL。
        スロー:
        java.lang.IllegalArgumentException - blob キーが有効でないか、画像が含まれていないか、または指定されたサイズがサービスでサポートされていない場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
        関連情報:
        getServingUrl(BlobKey)
      • getServingUrl

        java.lang.String getServingUrl(ServingUrlOptions options)
        blob として保存されている画像を動的に提供できる URL を取得します。

        この URL は、世界中で利用できる高パフォーマンスの動的画像配信インフラストラクチャによって提供されます。このメソッドで返される URL は、常に公開 URL ですが、類推可能なものではありません。非公開の URL は現在サポートされていません。URL の提供を停止する場合は、その基本となる blob キーを削除します。これが反映されるまで、最長で 24 時間かかります。この URL 形式では、サイズ変更と切り抜きを動的に実行することもできますが、一定の制限があります。サイズ変更と切り抜きを動的に実行するには、この呼び出しで取得される URL の末尾にオプションを付加します。次に例を示します。getServingUrl -> "http://lh3.ggpht.com/SomeCharactersGoesHere"

        32 ピクセルのサイズ変更バージョン(アスペクト比を保持)を取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32" のように「=s32」を URL に追加します。

        32 ピクセルの切り抜きバージョンを取得するには、"http://lh3.ggpht.com/SomeCharactersGoesHere=s32-c" のように「=s32-c」を付加します。

        有効なサイズは、[0, 1600] の範囲の整数です(最大は SERVING_SIZES_LIMIT として利用できます)。

        パラメータ:
        options - 提供 URL を生成するための特定のオプション。
        戻り値:
        画像を動的に提供できる URL。
        スロー:
        java.lang.IllegalArgumentException - オプションに有効な blobKey または googleStorageFileName が含まれていない場合。
        ImagesServiceFailureException - Images Service に問題がある場合。
      • deleteServingUrl

        void deleteServingUrl(BlobKey blobKey)
        getServingUrl(BlobKey) によって前に生成された URL を削除します。
        パラメータ:
        blobKey - 提供 URL を作成する呼び出しで前に使用された blob キー。
        スロー:
        java.lang.IllegalArgumentException - blob キーが有効でない場合。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境