doc.model_fiware_wiki.ftl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kurento-module-creator Show documentation

Tool that generates code for RPC between the Kurento Media Server and remote libraries.

There is a newer version: 7.1.0

Show newest version

KurentoClient.html




Remote Classes
<#list module.remoteClasses as remoteClass>



    <#if remoteClass.extends??>
    

    <#if !remoteClass.abstract && remoteClass.constructor??>
    
    
        
            ${remoteClass.name}
        
    

        Parent Class
        ${remoteClass.extends.name}
    
    
        Constructor Parameters
        <#list remoteClass.constructor.params as param>
                ${param.type.name}
                <#if param.type.list>[]
                ${param.name}<#if param.optional>?
                
            
        
    
    

    
        Declared Methods
        <#list remoteClass.methods as method>
                

                <#if method.return??>${method.return.type.name}<#if method.return.type.list>[] ${method.name}<#rt>
                <#lt>(<#list method.params as param><#rt>
                <#lt>${param.type.name}<#if param.type.list>[] ${param.name}<#if param_has_next>, <#rt>
                <#lt>)
                
                
            
        
    

    
        Declared Events
        <#list remoteClass.events as event>
                ${event.name}
                
            
        
    










Events
<#list module.events as event>



    <#if event.extends??>
    
    
        
            ${event.name}
        
    

        Parent Class
        ${event.extends.name}
    
    

    
        Properties
        
            <#list event.properties as property>
            
                ${property.type.name}<#if property.type.list>[] ${property.name}
            
            
            
        
    









Types
<#list module.complexTypes as type>



    <#if type.typeFormat == "REGISTER">
    
    <#else>
    
    
        
            ${type.name}
        
    

        Properties
        
            <#list type.properties as property>
            
                ${property.type.name}<#if property.type.list>[] ${property.name}<#if property.optional>?
            
            
            
        
    

        Enum constants
        
            <#list type.values as value>
            
                ${value}

${remoteClass.name}
Parent Class	${remoteClass.extends.name}
Constructor Parameters	<#list remoteClass.constructor.params as param> ${param.type.name} <#if param.type.list>[] ${param.name}<#if param.optional>?
Declared Methods	<#list remoteClass.methods as method> <#if method.return??>${method.return.type.name}<#if method.return.type.list>[] ${method.name}<#rt> <#lt>(<#list method.params as param><#rt> <#lt>${param.type.name}<#if param.type.list>[] ${param.name}<#if param_has_next>, <#rt> <#lt>)
Declared Events	<#list remoteClass.events as event> ${event.name}

${event.name}
Parent Class	${event.extends.name}
Properties	<#list event.properties as property> ${property.type.name}<#if property.type.list>[] ${property.name}

${type.name}
Properties	<#list type.properties as property> ${property.type.name}<#if property.type.list>[] ${property.name}<#if property.optional>?
Enum constants	<#list type.values as value> ${value}