小米手机MIUI 10 媒体通知适配说明

1.媒体通知是什么

媒体通知（或称 Media template / Media style）是 Android 标准通知样式的一种，自 API 21（Android 5.0）引入，方便用户直接控制媒体内容，常见于音乐类、广播类应用。

MIUI 10 完全兼容该通知样式，并调整了视觉风格，以符合系统风格，如下图（第一条通知）。

2. 为什么要用系统的媒体通知？

音乐类应用已经都有自己的「自定义通知」可以控制音乐，那为什么还要用系统的媒体通知？

调用系统的媒体通知，系统就能做针对性的优化，如：

正在播放的媒体通知默认置顶 + 默认展开为大视图。
正在播放的媒体通知默认会出现在锁屏上（置顶+大视图）。

这些都能让内容更充分地曝光，也有利于提升用户体验。

注：不同于原生 Android O 允许所有通知出现在锁屏上，MIUI 限制了出现在锁屏的通知类型，以减少用户打扰。如果需要出现在锁屏上，需要前往设置 – 通知和状态栏 – 通知管理，找到对应应用，开启‘’锁屏通知‘’。

3. 如何适配系统媒体通知

3.1 媒体通知的两种视图

媒体通知有两种视图，分别称为：

标准视图 / compact view：标准的通知高度，最多显示3个按钮（actions）。
大视图 / expanded view：面积更大，最多显示5个按钮。

3.2 适配媒体通知

MIUI 10的媒体通知，基于 Android O，以下是几个重要的接口：

setLargeIcon()：设置大图，一般为封面图。
addAction：添加控件，最多5个。
setShowActionsInCompactView(int)：控制在 compact view 显示哪些控件。
setMediaSession(MediaSession.Token)：告知系统正在播放中，系统会将其置顶（若有多条媒体通知的话）

媒体通知代码示例如下：

Notification = new Notification.Builder()
    .setContentTitle("Havana(feat.Young Thug")
    .setContentText("Camila Cabello - Havana")
    .setSmallIcon(mySmallIcon)
    .setLargeIcon(album)
    .addAction(previousAction)
    .addAction(playAction)
    .addAction(nextAction)
    .addAction(playlistAction)
    .addAction(favoriteAction)
    .setOngoing(true)
    .setStyle(newNotification.MediaStyle()
        .setShowActionsInCompactView(1,2,3)
        .setMediaSession(mySession)))
    .build();

详细接口说明见官方文档：https://developer.android.com/reference/android/app/Notification.MediaStyle。

不过，以下接口在 MIUI 10 无法生效：

以上接口都可能会产生不协调的颜色，故暂时屏蔽。

4. FAQ

4.1. 如何判断 MIUI 版本

有以下方法：

android.os.SystemProperties.get("ro.miui.ui.version.code", "7");// 如果返回值是「8」，就是 MIUI 10

或

android.os.SystemProperties.get("ro.miui.ui.version.name", "");// 如果返回值是「V10」，就是 MIUI 10

4.2. 只有 MIUI 10 支持媒体通知吗

其实 MIUI 9 也支持媒体通知，但因为没有做好优化。所以，可以大体认为「只有 MIUI 10 支持媒体通知」，含国内版和国际版，且样式和逻辑统一。

4.3. 只要是 MIUI 10 就支持媒体通知吗？

是的。因为 Android 原生从 API 21 （android 5.0）就支持媒体通知了，详见 https://developer.android.com/reference/android/app/Notification.MediaStyle。而 MIUI 10 最低是兼容到 Android 6.0，所以只要是 MIUI 10就支持媒体通知。

4.4. MIUI 10 会禁用自定义通知吗

不会。但系统无法识别自定义通知的具体内容，只会当成普通通知处理。

4.5. MIUI 10 媒体通知的样式以后会变化吗

有可能。主要取决于：

Android 增加新的接口：我们后续会尽力兼容新的接口，并以此调整样式。
业务需求和用户反馈。

4.6. MIUI 以前自己做的锁屏音乐界面还有用吗

在 MIUI 10 上没有用了。由于那个页面的实现方式有较多问题，因此我们在 MIUI 10 上弃用了，改由在锁屏上显示媒体通知，来实现锁屏音乐控制的需求。

4.7. 第三方应用自己做的锁屏页面（如音乐类或运动类的覆盖式）还能用吗？

可以继续使用，MIUI 10 没有限制这个能力（不过前提是开启了「锁屏显示」的权限）。但我们不建议开发者做这么一个覆盖式的页面，因为用户体验很差，还是希望能够用媒体通知替代。

4.8. 如何测试

升级到 MIUI 10 最新开发版即可，支持的机型和下载链接如下（找到对应机型的最新开发版）：

国内版 ROM：https://www.miui.com/download.html
国际版 ROM：http://en.miui.com/download.html

OPPO推送服务端设置广播推送

广播推送

OPPO PUSH提供广播和单点推送两种下发消息的方式。以下是这两种推送方式的介绍及具体的API使用方式。

广播推送

广播推送主要用于向大批量用户推送同一条消息的场景，例如标签推送、大批量的注册ID推送等。一般情况下，广播消息会在同一时间向这批目标设备推送消息，如果设置了定速推送，则按照给定的速度均匀向圈定的目标推送消息。
使用广播推送，需要先在OPPO PUSH保存一条广播消息体，再通过创建好的消息体对应的消息ID，调用OPPO PUSH的广播推送接口推送该条消息。

保存通知栏消息内容体

接口详情

描述	内容
接口功能	保存消息内容体，获取消息Id
请求方法	POST
请求编码	UTF-8
Content-Type	application/x-www-form-urlencoded
请求路径	/server/v1/message/notification/save_message_content

请求参数

除了共有的鉴权参数外，消息体内容的参数均以key-value的形式填写在HTTP请求的body中。

名称	类型	必须	描述
auth_token	string	是	鉴权令牌，详见鉴权一章。

消息体内容参数：参数主要围绕消息体的具体内容，以及推送的方式，消息体内容参数设置详情可查看通知栏消息

响应参数

调用接口后，OPPO PUSH会响应JSON格式的字符串，包含以下字段：

名称	类型	必须	描述
code	Int	是	返回码,具体含义请参考调用地址，公共参数和返回码一章。
message	String	否	响应信息描述
data	String	否	JSON格式的响应返回值，成功调用将包含消息ID，后续需要使用消息ID来进行广播消息推送。

响应示例

{
    "code": 0,
    "message": "success",
    "data": {
        "message_id": "58ad47319e8d725350a5afd5" //消息ID
      }
}

调用广播推送

接口详情

描述	内容
接口功能	发送通知栏消息
请求方法	POST
Content-Type	application/x-www-form-urlencoded
请求编码	UTF-8
请求路径	/server/v1/message/notification/broadcast

请求参数

名称	类型	必须	默认	描述
auth_token	string	是	无	鉴权令牌，详见鉴权一章。
message_id	String	是	无	消息ID。消息ID是调用保存消息体接口成功后响应的唯一标识。广播通知栏消息ID的格式为AppID-1-3-ObjectID，如ZngnvJIM7wQusNtbqYnpH6XX-1-3-622ea78f923805b1389e61c2，其中ZngnvJIM7wQusNtbqYnpH6XX是某个业务的AppID，622ea78f923805b1389e61c2是这条消息在Push的唯一ID。
target_type	Short	是	无	目标类型。接受一个short类型数字，目前推送目标可指定以下几种： 2:表示推送目标为注册ID类型， 5:表示推送目标为别名类型， 6:表示推送目标按照标签对应的用户群圈定；
target_value	String	否	无	具体的推送目标用户信息，根据推送目标类型有不同的传入方式： 1.注册ID类型或别名类型的推送。这两种类型一次调用可传入最多1000个目标，目标之间以英文字符 ; 为分隔符。如传入注册ID目标列表，字符串可表示为 “RegID1;RegID2;RegID3”，或者别名名单 “Alias1;Alias2;Alias3” 。标签： 2.标签推送。标签推送的目标值使用标签表达式。标签表达式由一个或多个指令组合而成，一个指令包括组合字段和标签名单，表示若干个标签的组合搭配。假设有一个标签表达式，标签表达式的配置和计算规则如下： { “or” : [ “tagID1”, ” tagID2″ ], “and” : [ “tagID3”, “tagID4”], “not” : [ “tagID5”, “tagID6”] } 表达式逻辑计算如下：计算 “or” 字段的结果，得到tagID1和tagID2的并集A;计算 “and” 字段的结果 tagID3和tagID4的交集B; 计算 “not” 字段的结果 (tagID5和tagID6的并集C’)的非集=C最后计算所有A和B和C的交集。最终结果为 (tagID1 ∪ tagID2)∩(tagID3 ∩ tagID4)∩(¬(tagID5 ∩ tagID6))

响应参数（JSON）

名称	类型	必须	描述
code	Int	是	返回码,具体含义请参考调用地址，公共参数和返回码一章
message	String	否	响应信息描述
data	String	否	JSON格式的响应返回值，成功调用将包含消息ID和任务ID。

推送请求调用成功响应示例

{
    code:0,
    message: "success",
    data : {
        message_id : xxxxxxxxx // 消息Id
        task_id : xxxxxxxxx // taskId
    }
}

如果推送目标存在问题，会根据对应异常的目标进行响应，示例如下：

{
    code:0,
    message: "",
    data : {
        message_id : xxxxxxxxx, // 消息ID
        task_id:XXXXXXXXXX,     //推送任务ID
        // 部分目标有异常，将以 错误码——对应目标名单的形式返回
        "10000": [
            "J0476035d625e6c64567f71487e040e7d017f0558675b",
            "J0476045d625e6c64567f71487e040e7d017f0558675b",
            "J0476035d625e6sd64567f71487e040e7d017f0558675b"
        ]
   }
}

返回码（code）

Code	英文描述	中文描述
10000	Invalid Registration_id	registration_id格式不正确

APP开发

开发APP从一门开始

标签归档：广播

小米手机MIUI 10 媒体通知适配说明

1.媒体通知是什么

2. 为什么要用系统的媒体通知？

3. 如何适配系统媒体通知

3.1 媒体通知的两种视图

3.2 适配媒体通知

4. FAQ

4.1. 如何判断 MIUI 版本

4.2. 只有 MIUI 10 支持媒体通知吗

4.3. 只要是 MIUI 10 就支持媒体通知吗？

4.4. MIUI 10 会禁用自定义通知吗

4.5. MIUI 10 媒体通知的样式以后会变化吗

4.6. MIUI 以前自己做的锁屏音乐界面还有用吗

4.7. 第三方应用自己做的锁屏页面（如音乐类或运动类的覆盖式）还能用吗？

4.8. 如何测试

OPPO推送服务端设置广播推送

广播推送

广播推送

保存通知栏消息内容体

接口详情

请求参数

响应参数

响应示例

调用广播推送

接口详情

请求参数

响应参数（JSON）

推送请求调用成功响应示例

返回码（code）