keys.h

Go to the documentation of this file.

/* PipeWire
 *
 * Copyright © 2019 Wim Taymans
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef PIPEWIRE_KEYS_H
#define PIPEWIRE_KEYS_H

#ifdef __cplusplus
extern "C" {
#endif

/* Peroperties usually set on the core object */
#define PW_KEY_USER_NAME                "pipewire.user-name"    
#define PW_KEY_HOST_NAME                "pipewire.host-name"    
#define PW_KEY_CORE_NAME                "pipewire.core.name"    
#define PW_KEY_CORE_VERSION             "pipewire.core.version" 
#define PW_KEY_CORE_DAEMON              "pipewire.core.daemon"  
#define PW_KEY_PROTOCOL                 "pipewire.protocol"
#define PW_KEY_ACCESS                   "pipewire.access"       
#define PW_KEY_SEC_PID                  "pipewire.sec.pid"      
#define PW_KEY_SEC_UID                  "pipewire.sec.uid"      
#define PW_KEY_SEC_GID                  "pipewire.sec.gid"      
#define PW_KEY_SEC_LABEL                "pipewire.sec.label"    
#define PW_KEY_LIBRARY_NAME_SYSTEM      "library.name.system"   
#define PW_KEY_LIBRARY_NAME_LOOP        "library.name.loop"     
#define PW_KEY_LIBRARY_NAME_DBUS        "library.name.dbus"     
#define PW_KEY_CORE_MONITORS            "core.monitors"         
/* remote keys */
#define PW_KEY_REMOTE_NAME              "remote.name"           
#define PW_KEY_REMOTE_INTENTION         "remote.intention"      
#define PW_KEY_APP_NAME                 "application.name"      
#define PW_KEY_APP_ID                   "application.id"        
#define PW_KEY_APP_VERSION              "application.version"
#define PW_KEY_APP_ICON                 "application.icon"      
#define PW_KEY_APP_ICON_NAME            "application.icon-name" 
#define PW_KEY_APP_LANGUAGE             "application.language"  
#define PW_KEY_APP_PROCESS_ID           "application.process.id"        
#define PW_KEY_APP_PROCESS_BINARY       "application.process.binary"    
#define PW_KEY_APP_PROCESS_USER         "application.process.user"      
#define PW_KEY_APP_PROCESS_HOST         "application.process.host"      
#define PW_KEY_APP_PROCESS_MACHINE_ID   "application.process.machine-id" 
#define PW_KEY_APP_PROCESS_SESSION_ID   "application.process.session-id" 
#define PW_KEY_WINDOW_X11_DISPLAY       "window.x11.display"    
#define PW_KEY_CLIENT_NAME              "client.name"           
#define PW_KEY_CLIENT_API               "client.api"            
#define PW_KEY_NODE_ID                  "node.id"               
#define PW_KEY_NODE_NAME                "node.name"             
#define PW_KEY_NODE_PLUGGED             "node.plugged"          
#define PW_KEY_NODE_SESSION             "node.session"          
#define PW_KEY_NODE_EXCLUSIVE           "node.exclusive"        
#define PW_KEY_NODE_AUTOCONNECT         "node.autoconnect"      
#define PW_KEY_NODE_TARGET              "node.target"           
#define PW_KEY_NODE_LATENCY             "node.latency"          
#define PW_KEY_NODE_DONT_RECONNECT      "node.dont-reconnect"   
#define PW_KEY_NODE_PAUSE_ON_IDLE       "node.pause-on-idle"    
#define PW_KEY_NODE_DRIVER              "node.driver"           
#define PW_KEY_NODE_STREAM              "node.stream"           
#define PW_KEY_PORT_ID                  "port.id"               
#define PW_KEY_PORT_NAME                "port.name"             
#define PW_KEY_PORT_DIRECTION           "port.direction"        
#define PW_KEY_PORT_ALIAS1              "port.alias1"           
#define PW_KEY_PORT_ALIAS2              "port.alias2"           
#define PW_KEY_PORT_PHYSICAL            "port.physical"         
#define PW_KEY_PORT_TERMINAL            "port.terminal"         
#define PW_KEY_PORT_CONTROL             "port.control"          
#define PW_KEY_PORT_MONITOR             "port.monitor"          
#define PW_KEY_LINK_INPUT_NODE          "link.input.node"       
#define PW_KEY_LINK_INPUT_PORT          "link.input.port"       
#define PW_KEY_LINK_OUTPUT_NODE         "link.output.node"      
#define PW_KEY_LINK_OUTPUT_PORT         "link.output.port"      
#define PW_KEY_LINK_PASSIVE             "link.passive"          
#define PW_KEY_DEVICE_NAME              "device.name"           
#define PW_KEY_DEVICE_PLUGGED           "device.plugged"        
#define PW_KEY_DEVICE_NICK              "device.nick"           
#define PW_KEY_DEVICE_STRING            "device.string"         
#define PW_KEY_DEVICE_API               "device.api"            
#define PW_KEY_DEVICE_DESCRIPTION       "device.description"    
#define PW_KEY_DEVICE_BUS_PATH          "device.bus-path"       
#define PW_KEY_DEVICE_SERIAL            "device.serial"         
#define PW_KEY_DEVICE_VENDOR_ID         "device.vendor.id"      
#define PW_KEY_DEVICE_VENDOR_NAME       "device.vendor.name"    
#define PW_KEY_DEVICE_PRODUCT_ID        "device.product.id"     
#define PW_KEY_DEVICE_PRODUCT_NAME      "device.product.name"   
#define PW_KEY_DEVICE_CLASS             "device.class"          
#define PW_KEY_DEVICE_FORM_FACTOR       "device.form-factor"    
#define PW_KEY_DEVICE_BUS               "device.bus"            
#define PW_KEY_DEVICE_SUBSYSTEM         "device.subsystem"      
#define PW_KEY_DEVICE_ICON              "device.icon"           
#define PW_KEY_DEVICE_ICON_NAME         "device.icon-name"      
#define PW_KEY_DEVICE_INTENDED_ROLES    "device.intended-roles" 
#define PW_KEY_MODULE_NAME              "module.name"           
#define PW_KEY_MODULE_AUTHOR            "module.author"         
#define PW_KEY_MODULE_DESCRIPTION       "module.description"    
#define PW_KEY_MODULE_USAGE             "module.usage"          
#define PW_KEY_MODULE_VERSION           "module.version"        
#define PW_KEY_FACTORY_NAME             "factory.name"          
#define PW_KEY_FACTORY_USAGE            "factory.usage"         
#define PW_KEY_FACTORY_TYPE_NAME        "factory.type.name"     
#define PW_KEY_FACTORY_TYPE_VERSION     "factory.type.version"  
#define PW_KEY_STREAM_IS_LIVE           "stream.is-live"        
#define PW_KEY_STREAM_LATENCY_MIN       "stream.latency.min"    
#define PW_KEY_STREAM_LATENCY_MAX       "stream.latency.max"    
#define PW_KEY_STREAM_MONITOR           "stream.monitor"        
#define PW_KEY_OBJECT_LINGER            "object.linger"         
#define PW_KEY_MEDIA_TYPE               "media.type"            
#define PW_KEY_MEDIA_CATEGORY           "media.category"        
#define PW_KEY_MEDIA_ROLE               "media.role"            
#define PW_KEY_MEDIA_CLASS              "media.class"           
#define PW_KEY_MEDIA_NAME               "media.name"            
#define PW_KEY_MEDIA_TITLE              "media.title"           
#define PW_KEY_MEDIA_ARTIST             "media.artist"          
#define PW_KEY_MEDIA_COPYRIGHT          "media.copyright"       
#define PW_KEY_MEDIA_SOFTWARE           "media.software"        
#define PW_KEY_MEDIA_LANGUAGE           "media.language"        
#define PW_KEY_MEDIA_FILENAME           "media.filename"        
#define PW_KEY_MEDIA_ICON               "media.icon"            
#define PW_KEY_MEDIA_ICON_NAME          "media.icon-name"       
#define PW_KEY_FORMAT_DSP               "format.dsp"            
#define PW_KEY_AUDIO_CHANNEL            "audio.channel"         
#define PW_KEY_AUDIO_RATE               "audio.samplerate"      
#define PW_KEY_AUDIO_CHANNELS           "audio.channels"        
#define PW_KEY_AUDIO_FORMAT             "audio.format"          
#define PW_KEY_VIDEO_RATE               "video.framerate"       
#define PW_KEY_VIDEO_FORMAT             "video.format"          
#define PW_KEY_VIDEO_SIZE               "video.size"            
#ifdef __cplusplus
}
#endif

#endif /* PIPEWIRE_KEYS_H */