com.jfinal.weixin.sdk.api

## 类 MediaApi

- java.lang.Object
- - com.jfinal.weixin.sdk.api.MediaApi

-     public class MediaApi
      extends Object

  素材管理
  作者:
    l.cm 文档：http://mp.weixin.qq.com/wiki/5/963fc70b80dc75483a271298a76a8d59.html

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `MediaApi.MediaType` 上传的临时多媒体文件有格式 分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）

  - ### 构造器概要

    构造器
    构造器和说明
    `MediaApi()`

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static ApiResult` | `addMaterial(File file, MediaApi.MediaType mediaType)` 新增其他类型永久素材
    `static ApiResult` | `addMaterial(File file, String title, String introduction)` 新增视频永久素材 素材的格式大小等要求与公众平台官网一致。
    `static ApiResult` | `addNews(List<MediaArticles> mediaArticles)` 新增永久图文素材
    `static ApiResult` | `batchGetMaterial(MediaApi.MediaType mediaType, int offset, int count)` 获取素材列表
    `static ApiResult` | `delMaterial(String media_id)` 删除永久素材
    `static MediaFile` | `getJssdkMedia(String media_id)` 高清语音素材获取接口 公众号可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材，格式为speex，16K采样率。
    `static InputStream` | `getMaterial(String media_id)` 获取永久素材
    `static ApiResult` | `getMaterialCount()` 获取素材总数
    `static MediaFile` | `getMedia(String media_id)` 获取临时素材
    `static ApiResult` | `updateNews(String media_id, int index, MediaArticles mediaArticles)` 修改永久图文素材
    `static ApiResult` | `uploadImg(File imgFile)` 上传图文消息内的图片获取URL 请注意，本接口所上传的图片不占用公众号的素材库中图片数量的5000个的限制。
    `static ApiResult` | `uploadMedia(MediaApi.MediaType mediaType, File file)` 上传临时素材
    `static ApiResult` | `uploadNews(List<MediaArticles> mediaArticles)` 上传图文消息素材【订阅号与服务号认证后均可用】
    `static ApiResult` | `uploadVideo(String mediaId, String title, String description)` 视频群发的消息素材上传

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### MediaApi

          public MediaApi()

  - ### 方法详细资料

    - #### uploadMedia

          public static ApiResult uploadMedia(MediaApi.MediaType mediaType,
                                              File file)

      上传临时素材
      参数:
        `mediaType` - 上传的临时多媒体文件有格式
        `file` - 需要上传的文件
      返回:
        ApiResult

    - #### uploadVideo

          public static ApiResult uploadVideo(String mediaId,
                                              String title,
                                              String description)

      视频群发的消息素材上传
      参数:
        `mediaId` - 用于群发的消息的media_id
        `title` - 消息的标题
        `description` - 消息的描述
      返回:
        {ApiResult}

    - #### uploadNews

          public static ApiResult uploadNews(List<MediaArticles> mediaArticles)

      上传图文消息素材【订阅号与服务号认证后均可用】
      参数:
        `mediaArticles` - 素材实体
      返回:
        {ApiResult}

    - #### getMedia

          public static MediaFile getMedia(String media_id)

      获取临时素材
      参数:
        `media_id` - 素材Id
      返回:
        MediaFile

    - #### getJssdkMedia

          public static MediaFile getJssdkMedia(String media_id)

      高清语音素材获取接口 公众号可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材，格式为speex，16K采样率。 该音频比上文的临时素材获取接口（格式为amr，8K采样率）更加清晰，适合用作语音识别等对音质要求较高的业务。
      参数:
        `media_id` - 素材Id
      返回:
        MediaFile

    - #### addNews

          public static ApiResult addNews(List<MediaArticles> mediaArticles)

      新增永久图文素材
      参数:
        `mediaArticles` - 图文列表
      返回:
        ApiResult

    - #### uploadImg

          public static ApiResult uploadImg(File imgFile)

      上传图文消息内的图片获取URL 请注意，本接口所上传的图片不占用公众号的素材库中图片数量的5000个的限制。 图片仅支持jpg/png格式，大小必须在1MB以下。
      参数:
        `imgFile` - 图片文件
      返回:
        ApiResult

    - #### addMaterial

          public static ApiResult addMaterial(File file,
                                              MediaApi.MediaType mediaType)

      新增其他类型永久素材
      参数:
        `file` - 文件
        `mediaType` - 素材类型
      返回:
        ApiResult

    - #### addMaterial

          public static ApiResult addMaterial(File file,
                                              String title,
                                              String introduction)

      新增视频永久素材 素材的格式大小等要求与公众平台官网一致。 具体是，图片大小不超过2M，支持bmp/png/jpeg/jpg/gif格式，语音大小不超过5M，长度不超过60秒，支持mp3/wma/wav/amr格式
      参数:
        `file` - 文件
        `title` - 文件标题
        `introduction` - 介绍
      返回:
        ApiResult

    - #### getMaterial

          public static InputStream getMaterial(String media_id)

      获取永久素材
      参数:
        `media_id` - 要获取的素材的media_id
      返回:
        InputStream 流，考虑到这里可能返回json或file请自行使用IOUtils转换

    - #### delMaterial

          public static ApiResult delMaterial(String media_id)

      删除永久素材
      参数:
        `media_id` - 要获取的素材的media_id
      返回:
        ApiResult 返回信息

    - #### updateNews

          public static ApiResult updateNews(String media_id,
                                             int index,
                                             MediaArticles mediaArticles)

      修改永久图文素材
      参数:
        `media_id` - 要修改的图文消息的id
        `index` - 要更新的文章在图文消息中的位置（多图文消息时，此字段才有意义），第一篇为0
        `mediaArticles` - 图文素材
      返回:
        ApiResult 返回信息

    - #### getMaterialCount

          public static ApiResult getMaterialCount()

      获取素材总数
      返回:
        ApiResult 返回信息

    - #### batchGetMaterial

          public static ApiResult batchGetMaterial(MediaApi.MediaType mediaType,
                                                   int offset,
                                                   int count)

      获取素材列表
      参数:
        `mediaType` - 素材的类型，图片（image）、视频（video）、语音 （voice）、图文（news）
        `offset` - 从全部素材的该偏移位置开始返回，0表示从第一个素材 返回
        `count` - 返回素材的数量，取值在1到20之间
      返回:
        ApiResult 返回信息

Copyright © 2017. All rights reserved.