到顶部
Android API
公众的

壁纸管理员

延伸对象
java.lang.Object(java.lang.对象)
android应用程序。壁纸管理员

课程概述

提供对系统墙纸的访问。使用WallpaperManager,您可以获取当前壁纸,获取壁纸所需的尺寸,设置壁纸等等。使用获取WallpaperManager实例获取实例()

总结

常量
字符串 行动_改变_现场_墙纸 直接启动实时壁纸预览,允许用户立即确认切换到特定的实时壁纸。
字符串 动作CROP_AND_SET_WALLPAPER 活动操作:显示选择墙纸的设置。
字符串 动作_LIVE_WALLPAPER_CHOOSER 启动活动,让用户选择当前全球直播壁纸。
字符串 命令_丢弃 用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):由壁纸报告当用户将对象拖放到主机的某个区域时。
字符串 命令_秒_TAP 用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):墙纸报道当用户在空白区域上释放第二个指针时主机(不在主机中执行操作)。
字符串 命令_ AP 用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):墙纸报道当用户点击空白区域时(不执行操作在主机中)。
字符串 附加_墙纸_组件 中的额外项行动_改变_现场_墙纸它指定了应显示为预览的实时壁纸的ComponentName,供用户确认。
字符串 墙纸_审查_数据_数据 响应的活动的清单条目操作_壁纸这允许他们提供与此操作关联的自定义大图标。
公共方法
空隙 清楚的()
删除所有当前设置的壁纸,恢复为系统内置壁纸。
空隙 清除墙纸偏移(I指示器windowToken)
通过清除以前与此窗口关联的偏移设置墙纸偏移(IBinder、float、float)
空隙 忘记加载的墙纸()
删除最后加载的壁纸的所有内部引用。
可提取 获取内置可绘制()
返回系统内置静态壁纸的可绘制内容。
可提取 获取内置可绘制(int outWidth、int outHeight、boolean scaleToFit、float horizontalAlignment、float verticalAlignment)
返回系统内置静态壁纸的可绘制内容。
意图 获取裁剪并设置墙纸意图(乌里imageUri)
获取一个Intent,该Intent将启动一个活动,以裁剪给定的图像并设置设备的壁纸。
整数 获得所需最小高度()
返回壁纸所需的最小高度。
整数 获得所需最小宽度()
返回壁纸所需的最小宽度。
可提取 获取可绘制()
检索当前系统壁纸;如果未设置壁纸,则返回系统内置的静态壁纸。
可提取 获得快速绘制()
喜欢获取可绘制(),但返回的Drawable有一个数字尽可能减少其开销。
静止的壁纸管理员 获取实例(上下文上下文)
检索与给定上下文关联的WallpaperManager。
墙纸信息 获取墙纸信息()
如果当前壁纸是活动壁纸组件,则返回关于那张壁纸的信息。
布尔值 有资源墙纸(整数剩余)
返回当前是否有用户设置为使用壁纸具有给定的资源ID。
可提取 peek可绘制()
检索当前系统壁纸;如果没有设置壁纸,返回空指针。
可提取 peekFastDrawable(快速绘制)()
喜欢获取快速绘制(),但如果没有设置壁纸,返回空指针。
空隙 发送墙纸命令(I指示器windowToken,窗口令牌,字符串操作,int x,int y,int z,捆绑额外费用)
向当前活动壁纸发送任意命令。
空隙 设置位图(位图位图)
将当前系统墙纸更改为位图。
空隙 设置资源(整数剩余)
将当前系统墙纸更改为给定资源中的位图。
空隙 setStream(设置流)(InputStream(输入流)数据)
将当前系统墙纸更改为特定的字节流。
空隙 设置墙纸偏移步骤(浮点xStep,浮点yStep)
对于使用多个虚拟屏幕显示墙纸的应用程序,指定虚拟屏幕之间的步长。
空隙 设置墙纸偏移(I指示器windowToken、float xOffset、float yOffset)
设置当前壁纸在任何较大空间内的位置,当在给定的窗口后面可以看到壁纸。
空隙 建议所需尺寸(int minimumWidth,int minimum Height)
仅用于当前主应用程序,以指定要使用的壁纸。
[展开]
继承的方法
来自班级java.lang.Object(java.lang.对象)

常量

公众静态的最终的字符串 行动_改变_现场_墙纸

已在中添加API级别16

直接启动实时壁纸预览,允许用户立即确认切换到特定的实时壁纸。您必须指定附加_墙纸_组件ComponentName为要显示的活动壁纸组件。

常量值: “android.service.wallpaper.CHANGE_LIVE_wallpaper”

公众静态的最终的字符串 动作CROP_AND_SET_WALLPAPER

已在中添加API等级19

活动操作:显示选择墙纸的设置。不要直接用于构造意图;相反,使用getCropAndSetWallpaperIntent(Uri)

输入:获取数据()是要裁剪并设置为壁纸的图像的URI。

输出:如果用户决定裁剪/设置墙纸,则返回RESULT_OK,否则返回RESULT_CANCEL支持此意图的活动应指定MIME过滤器“image/*”

常量值: “android.service.wallpaper.CROP_AND_SET_wallpaper”

公众静态的最终的字符串 动作_LIVE_WALLPAPER_CHOOSER

启动活动,让用户选择当前全球直播壁纸。

常量值: “android。服务。壁纸。LIVE_wallpaper_CHOOSER”

公众静态的最终的字符串 命令_ ROP

用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):墙纸报道当用户将对象拖放到主机的某个区域时。x轴和y参数是放置的位置。

常量值: “android.home.drop”

公众静态的最终的字符串 命令_秒_TAP

已在中添加API级别11

用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):由壁纸报告当用户在空白区域上释放第二个指针时主机(不在主机中执行操作)。x和y参数是屏幕坐标中第二个抽头的位置。

常量值: “android.wallpaper.secondaryTap”

公众静态的最终的字符串 命令_ AP

用于的命令sendWallpaperCommand(IBinder,String,int,int,Bundle):墙纸报道当用户点击空白区域时(不执行操作在主机中)。x和y参数是接头的位置屏幕坐标。

常量值: “android.wallpaper.tap”

公众静态的最终的字符串 附加_墙纸_组件

已在中添加API级别16

中的额外项行动_改变_现场_墙纸它指定了应显示为预览的实时壁纸的ComponentName,供用户确认。

常量值: “android.service.wallpaper.extral.LIVE_wallpaper_COMPONENT”

公众静态的最终的字符串 墙纸_审查_数据_数据

已在中添加API级别11

响应的活动的清单条目动作_设置_墙纸这允许他们提供与此操作关联的自定义大图标。

常量值: “android.wallpaper.preview”

公共方法

公众空隙 清楚的 ()

已在中添加API级别5

删除所有当前设置的壁纸,恢复为系统内置壁纸。成功后动作_墙纸_更改正在广播。

此方法要求调用方持有权限套装_墙纸

投掷
IO异常 如果发生错误,则恢复到内置壁纸。

公众空隙 清除墙纸偏移 (I指示器windowToken)

已在中添加API级别5

通过清除以前与此窗口关联的偏移设置墙纸偏移(IBinder、float、float)。这将恢复将窗口设置为默认状态,此时不会产生壁纸从其最后的偏移量开始滚动。

参数
windowToken窗口令牌 应关联这些偏移的窗口带有,由返回查看.getWindowToken()

公众空隙 忘记加载的墙纸 ()

已在中添加API级别14

删除最后加载的壁纸的所有内部引用。有用的对于那些只想暂时减少内存使用的应用程序需要有壁纸。调用后,下一个请求壁纸需要从磁盘重新加载。

公众的可提取 获取内置可绘制 ()

已在中添加API等级19

返回系统内置静态壁纸的可绘制内容。

公众的可提取 获取内置可绘制 (int outWidth,int outHeight,boolean scaleToFit,float horizontalAlignment,float verticalAlignment)

已在中添加API等级19

返回系统内置静态壁纸的可绘制内容。根据参数可裁剪可缩放

参数
outWidth(输出宽度) 返回拉拔件的高度
缩放到合适 如果是真的,请缩小墙纸的比例,而不只是裁剪它
水平对齐 介于0和1之间的浮点值,指定裁剪图像的位置;0表示左对齐,0.5表示水平居中对齐,1表示右对齐
垂直对齐 介于0和1之间的浮点值,指定裁剪图像的位置;0表示顶部对齐,0.5表示垂直中心对齐,1表示底部对齐

公众的意图 获取裁剪并设置墙纸意图 (乌里imageUri)

已在中添加API等级19

获取一个Intent,该Intent将启动一个活动,该活动裁剪给定的图像并设置设备的壁纸。如果有默认HOME活动如果支持裁剪壁纸,则首选该选项作为默认选项。使用此方法,而不是直接创建动作CROP_AND_SET_WALLPAPER意图。

参数
图像URI 将在意向中设置的图像URI。必须是内容URI及其提供程序必须将其类型解析为“image/*”
投掷
非法数据异常 如果URI不是内容URI或其MIME类型是不是“image/*”

公众整数 获得所需最小高度 ()

已在中添加API级别5

返回壁纸所需的最小高度。的呼叫者setBitmap(android.graphics.Bitmap)setStream(java.io.InputStream)应检查此值事先确保提供的壁纸符合要求最小高度。如果返回值<=0,调用方应使用高度默认显示。

退换商品
  • 壁纸所需的最小高度。该值应被设置墙纸的应用程序所尊重,但它不是强制性的。

公众整数 获得所需最小宽度 ()

已在中添加API级别5

返回壁纸所需的最小宽度。的呼叫者setBitmap(android.graphics.Bitmap)setStream(java.io.InputStream)应检查此值事先确保提供的壁纸符合要求最小宽度。如果返回值<=0,调用方应使用宽度改为默认显示。

退换商品
  • 壁纸所需的最小宽度。该值应被设置墙纸的应用程序所尊重,但它不是强制性的。

公众的可提取 获取可绘制 ()

已在中添加API级别5

检索当前系统壁纸;如果未设置壁纸,则返回系统内置的静态壁纸。这将作为abstract Drawable,可以安装在视图中以显示任何内容用户当前设置的墙纸。

退换商品
  • 返回将绘制壁纸的Drawable对象。

公众的可提取 获得快速绘制 ()

已在中添加API级别5

喜欢获取可绘制(),但返回的Drawable有一个数字尽可能减少其开销。它会的永远不要缩放壁纸(只有在要求边界时才将其居中不匹配位图边界,这不应该是典型的)允许设置alpha、颜色过滤器或其他属性等返回的drawable的边界将被初始化为相同的边界作为壁纸,所以通常您不需要触摸它drawable还假设它将在中运行的上下文中使用与屏幕的密度相同(不在密度兼容模式下)。

退换商品
  • 返回将绘制壁纸的Drawable对象。

公众静止的壁纸管理员 获取实例 (上下文上下文)

已在中添加API级别5

检索与给定上下文关联的WallpaperManager。

公众的墙纸信息 获取墙纸信息 ()

如果当前壁纸是活动壁纸组件,则返回关于那张壁纸的信息。否则,如果是静态图像,只需返回null。

公众布尔值 有资源墙纸 (整数剩余)

返回当前是否有用户设置为使用壁纸使用给定的资源ID,也就是说,他们的墙纸接通,接通setResource(int)具有相同的资源id。

公众的可提取 peek可绘制 ()

已在中添加API级别5

检索当前系统壁纸;如果没有壁纸,返回空指针。这将作为abstract Drawable,可以安装在视图中以显示任何内容用户当前设置的墙纸。

退换商品
  • 返回将绘制壁纸的Drawable对象或如果没有,则为空指针。

公众的可提取 peekFastDrawable(快速绘制) ()

已在中添加API级别5

喜欢获取快速绘制(),但如果没有设置壁纸,返回空指针。

退换商品
  • 返回优化的Drawable对象,该对象将绘制壁纸或空指针(如果没有)。

公众空隙 发送墙纸命令 (I指示器windowToken,字符串操作,int x,int y,int z,捆绑额外费用)

向当前活动壁纸发送任意命令。

参数
windowToken窗口令牌 应关联这些偏移的窗口带有,由返回查看.getWindowToken()
行动 要执行的命令的名称。这必须是一个范围名称以避免冲突,例如“com.mycompany.wallpaper.DOIT”。
x个 基于命令的任意整数参数。
基于命令的任意整数参数。
z(z) 基于命令的任意整数参数。
额外费用 命令的可选附加信息,或为null。

公众空隙 设置位图 (位图位图)

已在中添加API级别5

将当前系统壁纸更改为位图。给定位图为转换为PNG并存储为壁纸。成功后动作_墙纸_更改正在广播。

此方法要求调用方持有权限套装_墙纸

参数
位图 要保存的位图。
投掷
IO异常 如果发生错误,则恢复到内置壁纸。

公众空隙 设置资源 (整数剩余)

已在中添加API级别5

将当前系统墙纸更改为给定资源中的位图。资源作为原始数据流打开并复制到壁纸;它必须是有效的PNG或JPEG图像。成功后动作_墙纸_更改正在广播。

此方法要求调用方持有权限套装_墙纸

参数
渣油 要保存的位图。
投掷
IO异常 如果发生错误,则恢复到内置壁纸。

公众空隙 setStream(设置流) (InputStream(输入流)数据)

已在中添加API级别5

将当前系统墙纸更改为特定的字节流。这个give InputStream被复制到持久存储中,现在用作墙纸。当前必须是JPEG或PNG格式图像。关于成功,意图动作_墙纸_更改正在广播。

此方法要求调用方持有权限套装_墙纸

参数
数据 包含要安装为壁纸的原始数据的流。
投掷
IO异常 如果发生错误,则恢复到内置壁纸。

公众空隙 设置墙纸偏移步骤 (浮点xStep,浮点yStep)

对于使用多个虚拟屏幕显示墙纸的应用程序,指定虚拟屏幕之间的步长。例如,如果启动器有3个虚拟屏幕,它将指定xStep为0.5,因为这些屏幕的X偏移为0.0、0.5和1.0

参数
x步骤 从一个屏幕到下一个屏幕的X偏移增量
y步 从一个屏幕到下一个屏幕的Y偏移增量

公众空隙 设置墙纸偏移 (I指示器windowToken、float xOffset、float yOffset)

已在中添加API级别5

设置当前壁纸在任何较大空间内的位置,当在给定的窗口后面可以看到壁纸。X和Y偏移是从0到1的浮点数,表示壁纸应该放在屏幕空间内。只有这些当壁纸比屏幕大时,就有意义了。

参数
windowToken窗口令牌 应关联这些偏移的窗口带有,由返回查看.getWindowToken()
x偏移 沿X维度的偏移,从0到1。
y偏移 沿Y标注的偏移,从0到1。

公众空隙 建议的所需尺寸 (int minimumWidth,int minimum Height)

已在中添加API级别5

仅用于当前主应用程序,以指定它想用的墙纸。这允许此类应用程序具有比实际屏幕大的虚拟壁纸,匹配他们工作空间的大小。

请注意,开发人员似乎没有阅读此内容。这是对于主屏幕告诉他们想要什么尺寸的墙纸。其他人不应该这么说!当然不是其他非主屏幕更改墙纸的应用程序。这些应用程序应该检索建议的尺寸,以便他们制作墙纸这与之相符。

此方法要求调用方持有权限设置墙纸_内角

参数
最小宽度 所需最小宽度
最小高度 所需最小高度